naftiko: 1.0.0-alpha2 info: label: OVH Cloud OVHcloud API specification — Cloud description: 'OVH Cloud OVHcloud API specification — Cloud. 716 operations. Lead operation: OVH Cloud Get all cloud pending orders. Self-contained Naftiko capability covering one Ovh Cloud business surface.' tags: - Ovh Cloud - Cloud created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: OVH_CLOUD_API_KEY: OVH_CLOUD_API_KEY capability: consumes: - type: http namespace: ovh-cloud-cloud baseUri: https://api.us.ovhcloud.com/v1 description: OVH Cloud OVHcloud API specification — Cloud business capability. Self-contained, no shared references. resources: - name: cloud-order path: /cloud/order operations: - name: get method: GET description: OVH Cloud Get all cloud pending orders outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: planCode in: query type: string description: Order plan code - name: cloud-order-rule-availability path: /cloud/order/rule/availability operations: - name: get method: GET description: OVH Cloud Get product availability outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: addonFamily in: query type: string description: Addon family filter - name: ovhSubsidiary in: query type: string description: OVH subsidiary required: true - name: planCode in: query type: string description: Plan code filter - name: cloud-order-rule-instanceCategory path: /cloud/order/rule/instanceCategory operations: - name: get method: GET description: OVH Cloud Get instance categories outputRawFormat: json outputParameters: - name: result type: object value: $. - name: cloud-project path: /cloud/project operations: - name: get method: GET description: OVH Cloud List available services outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: iamTags in: query type: object description: Filter resources on IAM tags - name: cloud-project-serviceName path: /cloud/project/{serviceName} operations: - name: get method: GET description: OVH Cloud Get this object properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Alter this object properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-activateMonthlyBilling path: /cloud/project/{serviceName}/activateMonthlyBilling operations: - name: post method: POST description: OVH Cloud Activate monthly billing on multiple instances outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-capabilities-containerRegistry path: /cloud/project/{serviceName}/capabilities/containerRegistry operations: - name: get method: GET description: OVH Cloud List container registry capabilities per region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-capabilities-kube-admissionplugins path: /cloud/project/{serviceName}/capabilities/kube/admissionplugins operations: - name: get method: GET description: OVH Cloud List of admissionPlugins managed by MKS product that can be enabled or disabled. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-capabilities-kube-flavors path: /cloud/project/{serviceName}/capabilities/kube/flavors operations: - name: get method: GET description: OVH Cloud List Kubernetes available flavors for a region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: region in: query type: string description: 'The region to list available flavors from. Example: GRA11.' - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-capabilities-kube-log-kind path: /cloud/project/{serviceName}/capabilities/kube/log/kind operations: - name: get method: GET description: OVH Cloud List available log kinds outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-capabilities-kube-log-kind-name path: /cloud/project/{serviceName}/capabilities/kube/log/kind/{name} operations: - name: get method: GET description: OVH Cloud Get a log kind outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string description: Name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-capabilities-kube-regions path: /cloud/project/{serviceName}/capabilities/kube/regions operations: - name: get method: GET description: OVH Cloud List Kubernetes regions where cluster creation is possible. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-capabilities-loadbalancer-region path: /cloud/project/{serviceName}/capabilities/loadbalancer/region operations: - name: get method: GET description: OVH Cloud List all available regions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-capabilities-loadbalancer-region-regionName path: /cloud/project/{serviceName}/capabilities/loadbalancer/region/{regionName} operations: - name: get method: GET description: OVH Cloud Get specific information of a region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-capabilities-productAvailability path: /cloud/project/{serviceName}/capabilities/productAvailability operations: - name: get method: GET description: OVH Cloud List product availability outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: addonFamily in: query type: string description: Addon family filter - name: ovhSubsidiary in: query type: string description: OVH subsidiary required: true - name: planCode in: query type: string description: Plan code filter - name: planFamily in: query type: string description: Plan family filter (deprecated, use addonFamily instead) - name: product in: query type: string description: Product filter - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-confirmTermination path: /cloud/project/{serviceName}/confirmTermination operations: - name: post method: POST description: OVH Cloud Confirm service termination outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: The project id required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-containerRegistry path: /cloud/project/{serviceName}/containerRegistry operations: - name: get method: GET description: OVH Cloud List registries of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new registry outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-containerRegistry-registryID path: /cloud/project/{serviceName}/containerRegistry/{registryID} operations: - name: delete method: DELETE description: OVH Cloud Delete a registry outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get the registry information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update the registry outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-containerRegistry-registryID-capabilities-plan path: /cloud/project/{serviceName}/containerRegistry/{registryID}/capabilities/plan operations: - name: get method: GET description: OVH Cloud Get available plans for the current registry. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-containerRegistry-registryID-ipRestrictions-management path: /cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/management operations: - name: get method: GET description: OVH Cloud List your IP restrictions applied on Harbor UI and API outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Replace IP restrictions applied on Harbor UI and API outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-containerRegistry-registryID-ipRestrictions-registry path: /cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/registry operations: - name: get method: GET description: OVH Cloud List your IP restrictions applied on artifact manager component outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Replace IP restrictions applied on artifact manager component (Docker, Helm, etc...) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-containerRegistry-registryID-openIdConnect path: /cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect operations: - name: delete method: DELETE description: OVH Cloud Delete the registry's OIDC Configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get the registry's OIDC configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add or replace the registry's OIDC configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: put method: PUT description: OVH Cloud Edit the registry's OIDC configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-containerRegistry-registryID-plan path: /cloud/project/{serviceName}/containerRegistry/{registryID}/plan operations: - name: get method: GET description: OVH Cloud Show the actual plan of the registry. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update the plan of a registry. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-containerRegistry-registryID-users path: /cloud/project/{serviceName}/containerRegistry/{registryID}/users operations: - name: get method: GET description: OVH Cloud List registry user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new registry user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-containerRegistry-registryID-users-userID path: /cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID} operations: - name: delete method: DELETE description: OVH Cloud Delete a registry user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: userID in: path type: string description: UserID required: true - name: get method: GET description: OVH Cloud Get registry user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: userID in: path type: string description: UserID required: true - name: cloud-project-serviceName-containerRegistry-registryID-users-userID-setAsAdmin path: /cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}/setAsAdmin operations: - name: put method: PUT description: OVH Cloud Set the user as Admin outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: registryID in: path type: string description: RegistryID required: true - name: serviceName in: path type: string description: Service name required: true - name: userID in: path type: string description: UserID required: true - name: cloud-project-serviceName-database-availability path: /cloud/project/{serviceName}/database/availability operations: - name: get method: GET description: OVH Cloud Get database engines availability outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: action in: query type: string description: Type of action on which restrict the availabilities - name: clusterId in: query type: string description: Cluster ID on which restrict the availabilities - name: serviceName in: path type: string description: Service name required: true - name: target in: query type: string description: Type of target on which restrict the availabilities - name: cloud-project-serviceName-database-capabilities path: /cloud/project/{serviceName}/database/capabilities operations: - name: get method: GET description: OVH Cloud Get database engines capabilities outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra path: /cloud/project/{serviceName}/database/cassandra operations: - name: get method: GET description: OVH Cloud List all the cassandra clusters of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new cassandra cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-cassandra-clusterId path: /cloud/project/{serviceName}/database/cassandra/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a cassandra cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get cassandra cluster properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing cassandra cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-cassandra-clusterId-advancedConfiguration path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get cassandra advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update cassandra advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-cassandra-clusterId-backup path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/backup operations: - name: get method: GET description: OVH Cloud List backups of the cassandra outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-backup-backupId path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/backup/{backupId} operations: - name: get method: GET description: OVH Cloud Get cassandra backups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: backupId in: path type: string description: Backup ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-capabilities-advancedConf path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/capabilities/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get cassandra advanced configuration fields outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-capabilities-integration path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the cassandra service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-certificates path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/certificates operations: - name: get method: GET description: OVH Cloud Retrieve the certificates of the cassandra cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-integration path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-cassandra-clusterId-integration-integrationId path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-ipRestriction path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction operations: - name: get method: GET description: OVH Cloud List cassandra ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add ip restrictions to the cassandra outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-cassandra-clusterId-ipRestriction-ipBlock path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction/{ipBlock} operations: - name: delete method: DELETE description: OVH Cloud Deletes the given IP from the restricted IPs of the cassandra outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get cassandra ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Changes the list of ip restrictions to the cassandra outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-cassandra-clusterId-logs path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent cassandra log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-maintenance path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the cassandra cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-maintenance-maintenanceId path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the cassandra cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-maintenance-maintenanceId path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-metric path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the cassandra cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the cassandra cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-node path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the cassandra outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get cassandra nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-cassandra-clusterId-user path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/user operations: - name: get method: GET description: OVH Cloud List users of the cassandra outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new user on the cassandra cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-cassandra-clusterId-user-userId path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/user/{userId} operations: - name: delete method: DELETE description: OVH Cloud Delete a cassandra user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: get method: GET description: OVH Cloud Get cassandra users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-cassandra-clusterId-user-userId-credentials-r path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/user/{userId}/credentials/reset operations: - name: post method: POST description: OVH Cloud Resets the password of a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-grafana path: /cloud/project/{serviceName}/database/grafana operations: - name: get method: GET description: OVH Cloud List all the grafana of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new grafana cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-grafana-clusterId path: /cloud/project/{serviceName}/database/grafana/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a grafana cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get grafana cluster properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing grafana cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-grafana-clusterId-advancedConfiguration path: /cloud/project/{serviceName}/database/grafana/{clusterId}/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get grafana advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update grafana advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-grafana-clusterId-backup path: /cloud/project/{serviceName}/database/grafana/{clusterId}/backup operations: - name: get method: GET description: OVH Cloud List backups of the grafana outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-backup-backupId path: /cloud/project/{serviceName}/database/grafana/{clusterId}/backup/{backupId} operations: - name: get method: GET description: OVH Cloud Get grafana backups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: backupId in: path type: string description: Backup ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-capabilities-advancedConfig path: /cloud/project/{serviceName}/database/grafana/{clusterId}/capabilities/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get grafana advanced configuration fields outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-capabilities-integration path: /cloud/project/{serviceName}/database/grafana/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the grafana service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-integration path: /cloud/project/{serviceName}/database/grafana/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-grafana-clusterId-integration-integrationId path: /cloud/project/{serviceName}/database/grafana/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-ipRestriction path: /cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction operations: - name: get method: GET description: OVH Cloud List grafana ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add ip restrictions to the grafana outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-grafana-clusterId-ipRestriction-ipBlock path: /cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction/{ipBlock} operations: - name: delete method: DELETE description: OVH Cloud Deletes the given IP from the restricted IPs of the grafana outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get grafana ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Changes the list of ip restrictions to the grafana outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-grafana-clusterId-logs path: /cloud/project/{serviceName}/database/grafana/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent grafana log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-maintenance path: /cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the grafana cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-maintenance-maintenanceId path: /cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the grafana cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-maintenance-maintenanceId-a path: /cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-metric path: /cloud/project/{serviceName}/database/grafana/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the grafana cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/grafana/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the grafana cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-node path: /cloud/project/{serviceName}/database/grafana/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the grafana outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/grafana/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get grafana nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-user path: /cloud/project/{serviceName}/database/grafana/{clusterId}/user operations: - name: get method: GET description: OVH Cloud List users of the grafana outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-grafana-clusterId-user-userId path: /cloud/project/{serviceName}/database/grafana/{clusterId}/user/{userId} operations: - name: get method: GET description: OVH Cloud Get grafana users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-grafana-clusterId-user-userId-credentials-res path: /cloud/project/{serviceName}/database/grafana/{clusterId}/user/{userId}/credentials/reset operations: - name: post method: POST description: OVH Cloud Resets the password of a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-kafka path: /cloud/project/{serviceName}/database/kafka operations: - name: get method: GET description: OVH Cloud List all the kafka of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId path: /cloud/project/{serviceName}/database/kafka/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get kafka cluster properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-acl path: /cloud/project/{serviceName}/database/kafka/{clusterId}/acl operations: - name: get method: GET description: OVH Cloud List acls of the kafka outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new acl on the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-acl-aclId path: /cloud/project/{serviceName}/database/kafka/{clusterId}/acl/{aclId} operations: - name: delete method: DELETE description: OVH Cloud Delete a kafka acl outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: aclId in: path type: string description: Acl ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get kafka acls outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: aclId in: path type: string description: Acl ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-advancedConfiguration path: /cloud/project/{serviceName}/database/kafka/{clusterId}/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get kafka advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update kafka advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-capabilities-advancedConfigur path: /cloud/project/{serviceName}/database/kafka/{clusterId}/capabilities/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get kafka advanced configuration fields outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-capabilities-integration path: /cloud/project/{serviceName}/database/kafka/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the kafka service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-certificates path: /cloud/project/{serviceName}/database/kafka/{clusterId}/certificates operations: - name: get method: GET description: OVH Cloud Retrieve the certificates of the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-integration path: /cloud/project/{serviceName}/database/kafka/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-integration-integrationId path: /cloud/project/{serviceName}/database/kafka/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-ipRestriction path: /cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction operations: - name: get method: GET description: OVH Cloud List kafka ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add ip restrictions to the kafka outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-ipRestriction-ipBlock path: /cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction/{ipBlock} operations: - name: delete method: DELETE description: OVH Cloud Deletes the given IP from the restricted IPs of the kafka outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get kafka ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Changes the list of ip restrictions to the kafka outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-logs path: /cloud/project/{serviceName}/database/kafka/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent kafka log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-maintenance path: /cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-maintenance-maintenanceId path: /cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-maintenance-maintenanceId-app path: /cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-metric path: /cloud/project/{serviceName}/database/kafka/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/kafka/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-node path: /cloud/project/{serviceName}/database/kafka/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the kafka outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/kafka/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get kafka nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-permissions path: /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions operations: - name: get method: GET description: OVH Cloud Retrieve the permissions available on the cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-schemaRegistryAcl path: /cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl operations: - name: get method: GET description: OVH Cloud List schema registry acls of the kafka outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new schema registry acl on the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-schemaRegistryAcl-aclId path: /cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl/{aclId} operations: - name: delete method: DELETE description: OVH Cloud Delete a kafka schema registry acl outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: aclId in: path type: string description: Acl ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get kafka schema registry acls outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: aclId in: path type: string description: Acl ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-topic path: /cloud/project/{serviceName}/database/kafka/{clusterId}/topic operations: - name: get method: GET description: OVH Cloud List topics of the kafka outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new topic on the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-topic-topicId path: /cloud/project/{serviceName}/database/kafka/{clusterId}/topic/{topicId} operations: - name: delete method: DELETE description: OVH Cloud Delete a kafka topic outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: topicId in: path type: string description: Topic ID required: true - name: get method: GET description: OVH Cloud Get kafka topics outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: topicId in: path type: string description: Topic ID required: true - name: put method: PUT description: OVH Cloud Updates the topic on the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: topicId in: path type: string description: Topic ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-topicAcl path: /cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl operations: - name: get method: GET description: OVH Cloud List topic acls of the kafka outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new topic acl on the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-topicAcl-aclId path: /cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl/{aclId} operations: - name: delete method: DELETE description: OVH Cloud Delete a kafka topic acl outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: aclId in: path type: string description: Acl ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get kafka topic acls outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: aclId in: path type: string description: Acl ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafka-clusterId-user path: /cloud/project/{serviceName}/database/kafka/{clusterId}/user operations: - name: get method: GET description: OVH Cloud List users of the kafka outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new user on the kafka cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafka-clusterId-user-userId path: /cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId} operations: - name: delete method: DELETE description: OVH Cloud Delete a kafka user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: get method: GET description: OVH Cloud Get kafka users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-kafka-clusterId-user-userId-access path: /cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}/access operations: - name: get method: GET description: OVH Cloud Retrieve the user acces for the cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-kafka-clusterId-user-userId-credentials-reset path: /cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}/credentials/reset operations: - name: post method: POST description: OVH Cloud Resets the password of a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-kafkaConnect path: /cloud/project/{serviceName}/database/kafkaConnect operations: - name: get method: GET description: OVH Cloud List all the kafkaConnect of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new kafkaConnect cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a kafkaConnect cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get kafkaConnect cluster properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing kafkaConnect cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-advancedConfiguration path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get kafkaConnect advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update kafkaConnect advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-advancedC path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get kafkaConnect advanced configuration fields outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-connector path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector operations: - name: get method: GET description: OVH Cloud List Kafka Connect connectors outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-connector path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId} operations: - name: get method: GET description: OVH Cloud Get Kafka Connect connector capability outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-connector path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}/configuration operations: - name: get method: GET description: OVH Cloud Get Kafka Connect connector configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-connector path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}/transforms operations: - name: get method: GET description: OVH Cloud Get Kafka Connect connector transforms outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-integrati path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the kafkaConnect service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-connector path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector operations: - name: get method: GET description: OVH Cloud List the connectors outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new connector outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId} operations: - name: delete method: DELETE description: OVH Cloud Delete a connector outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get connector outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update a connector outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId- path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/pause operations: - name: post method: POST description: OVH Cloud Pause the kafka connector execution outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId- path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/restart operations: - name: post method: POST description: OVH Cloud Restart the kafka connector execution outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId- path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/resume operations: - name: post method: POST description: OVH Cloud Resume the kafka connector execution outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId- path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task operations: - name: get method: GET description: OVH Cloud List the connector tasks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId- path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task/{taskId} operations: - name: get method: GET description: OVH Cloud Get connector task outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: taskId in: path type: integer description: Task ID required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId- path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task/{taskId}/restart operations: - name: post method: POST description: OVH Cloud Restart the kafka connector task execution outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectorId in: path type: string description: Connector ID required: true - name: serviceName in: path type: string description: Service name required: true - name: taskId in: path type: integer description: Task ID required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-integration path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-integration-integratio path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-ipRestriction path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction operations: - name: get method: GET description: OVH Cloud List kafkaConnect ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add ip restrictions to the kafkaConnect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-ipRestriction-ipBlock path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction/{ipBlock} operations: - name: delete method: DELETE description: OVH Cloud Deletes the given IP from the restricted IPs of the kafkaConnect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get kafkaConnect ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Changes the list of ip restrictions to the kafkaConnect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-logs path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent kafkaConnect log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-maintenance path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the kafka connect cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-maintenance-maintenanc path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the kafka connect cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-maintenance-maintenanc path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-metric path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the kafkaConnect cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the kafkaConnect cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-node path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the kafkaConnect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get kafkaConnect nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-user path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user operations: - name: get method: GET description: OVH Cloud List users of the kafkaConnect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new user on the kafkaConnect cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-user-userId path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user/{userId} operations: - name: delete method: DELETE description: OVH Cloud Delete a kafkaConnect user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: get method: GET description: OVH Cloud Get kafkaConnect users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-kafkaConnect-clusterId-user-userId-credential path: /cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user/{userId}/credentials/reset operations: - name: post method: POST description: OVH Cloud Resets the password of a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker path: /cloud/project/{serviceName}/database/kafkaMirrorMaker operations: - name: get method: GET description: OVH Cloud List all the kafkaMirrorMaker of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new kafkaMirrorMaker outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a kafkaMirrorMaker outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get kafkaMirrorMaker properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing kafkaMirrorMaker outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-capabilities-integ path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the kafkaMirrorMaker service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-integration path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-integration-integr path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-logs path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent kafkaMirrorMaker log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-maintenance path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the kafka mirror maker cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-maintenance-mainte path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the kafka mirror maker cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-maintenance-mainte path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-metric path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the kafkaMirrorMaker outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the kafkaMirrorMaker outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-node path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the kafkaMirrorMaker outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get kafkaMirrorMaker nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-replication path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication operations: - name: get method: GET description: OVH Cloud List replication of the kafkaMirrorMaker outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new replication outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-replication-replic path: /cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication/{replicationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an replication outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: replicationId in: path type: string description: Replication ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get kafkaMirrorMaker replication outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: replicationId in: path type: string description: Replication ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Updates a replication outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: replicationId in: path type: string description: Replication ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3aggregator path: /cloud/project/{serviceName}/database/m3aggregator operations: - name: get method: GET description: OVH Cloud List all the m3aggregator of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new m3aggregator outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a m3aggregator outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get m3aggregator properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing m3aggregator outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-capabilities-integrati path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the m3aggregator service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-integration path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-integration-integratio path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-logs path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent m3aggregator log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-maintenance path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the m3aggregator cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-maintenance-maintenanc path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the m3aggregator cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-maintenance-maintenanc path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-metric path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the m3aggregator outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the m3aggregator outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-node path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the m3aggregator outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3aggregator-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/m3aggregator/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get m3aggregator nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db path: /cloud/project/{serviceName}/database/m3db operations: - name: get method: GET description: OVH Cloud List all the m3db clusters of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3db-clusterId path: /cloud/project/{serviceName}/database/m3db/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get m3db cluster properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3db-clusterId-advancedConfiguration path: /cloud/project/{serviceName}/database/m3db/{clusterId}/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get m3db advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update m3db advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3db-clusterId-backup path: /cloud/project/{serviceName}/database/m3db/{clusterId}/backup operations: - name: get method: GET description: OVH Cloud List backups of the m3db outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-backup-backupId path: /cloud/project/{serviceName}/database/m3db/{clusterId}/backup/{backupId} operations: - name: get method: GET description: OVH Cloud Get m3db backups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: backupId in: path type: string description: Backup ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-capabilities-advancedConfigura path: /cloud/project/{serviceName}/database/m3db/{clusterId}/capabilities/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get m3db advanced configuration fields outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-capabilities-integration path: /cloud/project/{serviceName}/database/m3db/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the m3db service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-integration path: /cloud/project/{serviceName}/database/m3db/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3db-clusterId-integration-integrationId path: /cloud/project/{serviceName}/database/m3db/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-ipRestriction path: /cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction operations: - name: get method: GET description: OVH Cloud List m3db ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add ip restrictions to the m3db outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3db-clusterId-ipRestriction-ipBlock path: /cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction/{ipBlock} operations: - name: delete method: DELETE description: OVH Cloud Deletes the given IP from the restricted IPs of the m3db outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get m3db ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Changes the list of ip restrictions to the m3db outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3db-clusterId-logs path: /cloud/project/{serviceName}/database/m3db/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent m3db log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-maintenance path: /cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-maintenance-maintenanceId path: /cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-maintenance-maintenanceId-appl path: /cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-metric path: /cloud/project/{serviceName}/database/m3db/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/m3db/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-namespace path: /cloud/project/{serviceName}/database/m3db/{clusterId}/namespace operations: - name: get method: GET description: OVH Cloud List namespaces of the m3db outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new namespace on the m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3db-clusterId-namespace-namespaceId path: /cloud/project/{serviceName}/database/m3db/{clusterId}/namespace/{namespaceId} operations: - name: delete method: DELETE description: OVH Cloud Delete m3db namespace outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: namespaceId in: path type: string description: Namespace ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get m3db namespaces outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: namespaceId in: path type: string description: Namespace ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Updates the namespace on the m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: namespaceId in: path type: string description: Namespace ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3db-clusterId-node path: /cloud/project/{serviceName}/database/m3db/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the m3db outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/m3db/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get m3db nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-m3db-clusterId-user path: /cloud/project/{serviceName}/database/m3db/{clusterId}/user operations: - name: get method: GET description: OVH Cloud List users of the m3db outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new user on the m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3db-clusterId-user-userId path: /cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId} operations: - name: delete method: DELETE description: OVH Cloud Delete m3db user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: get method: GET description: OVH Cloud Get m3db users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: put method: PUT description: OVH Cloud Updates the user on the m3db cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-m3db-clusterId-user-userId-credentials-reset path: /cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}/credentials/reset operations: - name: post method: POST description: OVH Cloud Resets the password of a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-mysql path: /cloud/project/{serviceName}/database/mysql operations: - name: get method: GET description: OVH Cloud List all the mysql of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-mysql-clusterId path: /cloud/project/{serviceName}/database/mysql/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get mysql cluster properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-mysql-clusterId-advancedConfiguration path: /cloud/project/{serviceName}/database/mysql/{clusterId}/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get mysql advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update mysql advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-mysql-clusterId-backup path: /cloud/project/{serviceName}/database/mysql/{clusterId}/backup operations: - name: get method: GET description: OVH Cloud List backups of the mysql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-backup-backupId path: /cloud/project/{serviceName}/database/mysql/{clusterId}/backup/{backupId} operations: - name: get method: GET description: OVH Cloud Get mysql backups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: backupId in: path type: string description: Backup ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-capabilities-advancedConfigur path: /cloud/project/{serviceName}/database/mysql/{clusterId}/capabilities/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get mysql advanced configuration fields outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-capabilities-integration path: /cloud/project/{serviceName}/database/mysql/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the mysql service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-certificates path: /cloud/project/{serviceName}/database/mysql/{clusterId}/certificates operations: - name: get method: GET description: OVH Cloud Retrieve the certificates of the mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-currentQueries path: /cloud/project/{serviceName}/database/mysql/{clusterId}/currentQueries operations: - name: get method: GET description: OVH Cloud Retrieve the current queries for the cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: limit in: query type: integer description: Limit size of the result set returned by the pagination - name: offset in: query type: integer description: Offset of the result set returned by the pagination - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-currentQueries-cancel path: /cloud/project/{serviceName}/database/mysql/{clusterId}/currentQueries/cancel operations: - name: post method: POST description: OVH Cloud Cancel the given current query of the cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-mysql-clusterId-database path: /cloud/project/{serviceName}/database/mysql/{clusterId}/database operations: - name: get method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new database on the mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-mysql-clusterId-database-databaseId path: /cloud/project/{serviceName}/database/mysql/{clusterId}/database/{databaseId} operations: - name: delete method: DELETE description: OVH Cloud Delete a mysql database outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: databaseId in: path type: string description: Database ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get the database for the mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: databaseId in: path type: string description: Database ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-enableWrites path: /cloud/project/{serviceName}/database/mysql/{clusterId}/enableWrites operations: - name: post method: POST description: OVH Cloud Enable temporary write permission on readonly lock mysql service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-integration path: /cloud/project/{serviceName}/database/mysql/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-mysql-clusterId-integration-integrationId path: /cloud/project/{serviceName}/database/mysql/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-ipRestriction path: /cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction operations: - name: get method: GET description: OVH Cloud List mysql ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add ip restrictions to the mysql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-mysql-clusterId-ipRestriction-ipBlock path: /cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction/{ipBlock} operations: - name: delete method: DELETE description: OVH Cloud Deletes the given IP from the restricted IPs of the mysql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get mysql ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Changes the list of ip restrictions to the mysql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-mysql-clusterId-logs path: /cloud/project/{serviceName}/database/mysql/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent mysql log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-maintenance path: /cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-maintenance-maintenanceId path: /cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-maintenance-maintenanceId-app path: /cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-metric path: /cloud/project/{serviceName}/database/mysql/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/mysql/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-node path: /cloud/project/{serviceName}/database/mysql/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the mysql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/mysql/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get mysql nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-queryStatistics path: /cloud/project/{serviceName}/database/mysql/{clusterId}/queryStatistics operations: - name: get method: GET description: OVH Cloud Retrieve the query statistics for the cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: limit in: query type: integer description: Limit size of the result set returned by the pagination - name: offset in: query type: integer description: Offset of the result set returned by the pagination - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-queryStatistics-reset path: /cloud/project/{serviceName}/database/mysql/{clusterId}/queryStatistics/reset operations: - name: post method: POST description: OVH Cloud Reset the query statistics of the cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-mysql-clusterId-user path: /cloud/project/{serviceName}/database/mysql/{clusterId}/user operations: - name: get method: GET description: OVH Cloud List users of the mysql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new user on the mysql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-mysql-clusterId-user-userId path: /cloud/project/{serviceName}/database/mysql/{clusterId}/user/{userId} operations: - name: delete method: DELETE description: OVH Cloud Delete a mysql user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: get method: GET description: OVH Cloud Get mysql users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-mysql-clusterId-user-userId-credentials-reset path: /cloud/project/{serviceName}/database/mysql/{clusterId}/user/{userId}/credentials/reset operations: - name: post method: POST description: OVH Cloud Resets the password of a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-opensearch path: /cloud/project/{serviceName}/database/opensearch operations: - name: get method: GET description: OVH Cloud List all the opensearch of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new opensearch cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-opensearch-clusterId path: /cloud/project/{serviceName}/database/opensearch/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a opensearch cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get opensearch cluster properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing opensearch cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-opensearch-clusterId-advancedConfiguration path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get opensearch advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update opensearch advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-opensearch-clusterId-backup path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/backup operations: - name: get method: GET description: OVH Cloud List backups of the opensearch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-backup-backupId path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/backup/{backupId} operations: - name: get method: GET description: OVH Cloud Get opensearch backups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: backupId in: path type: string description: Backup ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-capabilities-advancedCon path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/capabilities/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get opensearch advanced configuration fields outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-capabilities-integration path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the opensearch service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-index path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/index operations: - name: get method: GET description: OVH Cloud List indexes of the opensearch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-index-indexId path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/index/{indexId} operations: - name: delete method: DELETE description: OVH Cloud Delete an opensearch index outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: indexId in: path type: string description: Index ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get opensearch index outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: indexId in: path type: string description: Index ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-integration path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-opensearch-clusterId-integration-integrationI path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-ipRestriction path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction operations: - name: get method: GET description: OVH Cloud List opensearch ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add ip restrictions to the opensearch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-opensearch-clusterId-ipRestriction-ipBlock path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction/{ipBlock} operations: - name: delete method: DELETE description: OVH Cloud Deletes the given IP from the restricted IPs of the opensearch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get opensearch ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Changes the list of ip restrictions to the opensearch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-opensearch-clusterId-logs path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent opensearch log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-maintenance path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the opensearch cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-maintenance-maintenanceI path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the opensearch cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-maintenance-maintenanceI path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-metric path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the opensearch cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the opensearch cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-node path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the opensearch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get opensearch nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-pattern path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern operations: - name: get method: GET description: OVH Cloud List patterns of the opensearch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new pattern on the opensearch cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-opensearch-clusterId-pattern-patternId path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern/{patternId} operations: - name: delete method: DELETE description: OVH Cloud Delete an opensearch pattern outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: patternId in: path type: string description: Pattern ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get opensearch patterns outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: patternId in: path type: string description: Pattern ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-permissions path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/permissions operations: - name: get method: GET description: OVH Cloud Retrieve the opensearch permissions values outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-opensearch-clusterId-user path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/user operations: - name: get method: GET description: OVH Cloud List users of the opensearch outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new user on the opensearch cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-opensearch-clusterId-user-userId path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId} operations: - name: delete method: DELETE description: OVH Cloud Delete a opensearch user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: get method: GET description: OVH Cloud Get opensearch users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: put method: PUT description: OVH Cloud Update a user on the opensearch cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-opensearch-clusterId-user-userId-credentials- path: /cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}/credentials/reset operations: - name: post method: POST description: OVH Cloud Resets the password of a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-postgresql path: /cloud/project/{serviceName}/database/postgresql operations: - name: get method: GET description: OVH Cloud List all the postgresql of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId path: /cloud/project/{serviceName}/database/postgresql/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get postgresql cluster properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-advancedConfiguration path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get postgresql advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update postgresql advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-backup path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/backup operations: - name: get method: GET description: OVH Cloud List backups of the postgresql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-backup-backupId path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/backup/{backupId} operations: - name: get method: GET description: OVH Cloud Get postgresql backups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: backupId in: path type: string description: Backup ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-capabilities-advancedCon path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/capabilities/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get postgresql advanced configuration fields outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-capabilities-integration path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the postgresql service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-certificates path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/certificates operations: - name: get method: GET description: OVH Cloud Retrieve the certificates of the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-connectionPool path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool operations: - name: get method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new connectionPool on the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-connectionPool-connectio path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool/{connectionPoolId} operations: - name: delete method: DELETE description: OVH Cloud Delete a postgresql connectionPool outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectionPoolId in: path type: string description: Connection pool ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get the connectionPool for the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectionPoolId in: path type: string description: Connection pool ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update a connectionPool on the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: connectionPoolId in: path type: string description: Connection pool ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-currentQueries path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/currentQueries operations: - name: get method: GET description: OVH Cloud Retrieve the current queries for the cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: limit in: query type: integer description: Limit size of the result set returned by the pagination - name: offset in: query type: integer description: Offset of the result set returned by the pagination - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-currentQueries-cancel path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/currentQueries/cancel operations: - name: post method: POST description: OVH Cloud Cancel the given current query of the cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-database path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/database operations: - name: get method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new database on the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-database-databaseId path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/database/{databaseId} operations: - name: delete method: DELETE description: OVH Cloud Delete a postgresql database outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: databaseId in: path type: string description: Database ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get the database for the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: databaseId in: path type: string description: Database ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-enableWrites path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/enableWrites operations: - name: post method: POST description: OVH Cloud Enable temporary write permission on readonly lock postgresql service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-integration path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-integration-integrationI path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-ipRestriction path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction operations: - name: get method: GET description: OVH Cloud List postgresql ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add ip restrictions to the postgresql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-ipRestriction-ipBlock path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction/{ipBlock} operations: - name: delete method: DELETE description: OVH Cloud Deletes the given IP from the restricted IPs of the postgresql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get postgresql ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Changes the list of ip restrictions to the postgresql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-logs path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent postgresql log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-maintenance path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-maintenance-maintenanceI path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-maintenance-maintenanceI path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-metric path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-node path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the postgresql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get postgresql nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-queryStatistics path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/queryStatistics operations: - name: get method: GET description: OVH Cloud Retrieve the query statistics for the cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: limit in: query type: integer description: Limit size of the result set returned by the pagination - name: offset in: query type: integer description: Offset of the result set returned by the pagination - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-queryStatistics-reset path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/queryStatistics/reset operations: - name: post method: POST description: OVH Cloud Reset the query statistics of the cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-roles path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/roles operations: - name: get method: GET description: OVH Cloud Get postgresql roles outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-postgresql-clusterId-user path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/user operations: - name: get method: GET description: OVH Cloud List users of the postgresql outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new user on the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-user-userId path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId} operations: - name: delete method: DELETE description: OVH Cloud Delete a postgresql user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: get method: GET description: OVH Cloud Get postgresql users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: put method: PUT description: OVH Cloud Updates the user on the postgresql cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-postgresql-clusterId-user-userId-credentials- path: /cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}/credentials/reset operations: - name: post method: POST description: OVH Cloud Resets the password of a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-redis path: /cloud/project/{serviceName}/database/redis operations: - name: get method: GET description: OVH Cloud List all the redis of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new redis cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-redis-clusterId path: /cloud/project/{serviceName}/database/redis/{clusterId} operations: - name: delete method: DELETE description: OVH Cloud Delete a redis cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get redis cluster properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update an existing redis cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-redis-clusterId-advancedConfiguration path: /cloud/project/{serviceName}/database/redis/{clusterId}/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get redis advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update redis advanced configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-redis-clusterId-backup path: /cloud/project/{serviceName}/database/redis/{clusterId}/backup operations: - name: get method: GET description: OVH Cloud List backups of the redis outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-backup-backupId path: /cloud/project/{serviceName}/database/redis/{clusterId}/backup/{backupId} operations: - name: get method: GET description: OVH Cloud Get redis backups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: backupId in: path type: string description: Backup ID required: true - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-capabilities-advancedConfigur path: /cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/advancedConfiguration operations: - name: get method: GET description: OVH Cloud Get redis advanced configuration fields outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-capabilities-categories path: /cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/categories operations: - name: get method: GET description: OVH Cloud Get available categories in the redis service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-capabilities-commands path: /cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/commands operations: - name: get method: GET description: OVH Cloud Get available commands in the redis service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-capabilities-integration path: /cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/integration operations: - name: get method: GET description: OVH Cloud Get integration capabilities related to the redis service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-integration path: /cloud/project/{serviceName}/database/redis/{clusterId}/integration operations: - name: get method: GET description: OVH Cloud List integrations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-redis-clusterId-integration-integrationId path: /cloud/project/{serviceName}/database/redis/{clusterId}/integration/{integrationId} operations: - name: delete method: DELETE description: OVH Cloud Delete an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get an integration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: integrationId in: path type: string description: Integration ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-ipRestriction path: /cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction operations: - name: get method: GET description: OVH Cloud List redis ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add ip restrictions to the redis outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-redis-clusterId-ipRestriction-ipBlock path: /cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction/{ipBlock} operations: - name: delete method: DELETE description: OVH Cloud Deletes the given IP from the restricted IPs of the redis outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get redis ip restrictions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Changes the list of ip restrictions to the redis outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: ipBlock in: path type: string description: Ip block required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-redis-clusterId-logs path: /cloud/project/{serviceName}/database/redis/{clusterId}/logs operations: - name: get method: GET description: OVH Cloud Retrieve the most recent redis log messages (limited to 1000) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-maintenance path: /cloud/project/{serviceName}/database/redis/{clusterId}/maintenance operations: - name: get method: GET description: OVH Cloud List maintenances for the redis cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-maintenance-maintenanceId path: /cloud/project/{serviceName}/database/redis/{clusterId}/maintenance/{maintenanceId} operations: - name: get method: GET description: OVH Cloud Get the maintenance for the redis cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-maintenance-maintenanceId-app path: /cloud/project/{serviceName}/database/redis/{clusterId}/maintenance/{maintenanceId}/apply operations: - name: post method: POST description: OVH Cloud Apply the maintenance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: maintenanceId in: path type: string description: Maintenance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-metric path: /cloud/project/{serviceName}/database/redis/{clusterId}/metric operations: - name: get method: GET description: OVH Cloud List available metrics for the redis cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: extended in: query type: boolean description: Display DB specific metrics - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-metric-metricName path: /cloud/project/{serviceName}/database/redis/{clusterId}/metric/{metricName} operations: - name: get method: GET description: OVH Cloud Get the metric values for the redis cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: metricName in: path type: string description: Metric name required: true - name: period in: query type: string description: The period of time to query metrics for required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-node path: /cloud/project/{serviceName}/database/redis/{clusterId}/node operations: - name: get method: GET description: OVH Cloud List nodes of the redis outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-node-nodeId path: /cloud/project/{serviceName}/database/redis/{clusterId}/node/{nodeId} operations: - name: get method: GET description: OVH Cloud Get redis nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-redis-clusterId-user path: /cloud/project/{serviceName}/database/redis/{clusterId}/user operations: - name: get method: GET description: OVH Cloud List users of the redis outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new user on the redis cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-redis-clusterId-user-userId path: /cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId} operations: - name: delete method: DELETE description: OVH Cloud Delete a redis user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: get method: GET description: OVH Cloud Get redis users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: put method: PUT description: OVH Cloud Update a user on the redis cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-database-redis-clusterId-user-userId-credentials-reset path: /cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}/credentials/reset operations: - name: post method: POST description: OVH Cloud Resets the password of a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: cloud-project-serviceName-database-service path: /cloud/project/{serviceName}/database/service operations: - name: get method: GET description: OVH Cloud List database services of the project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: category in: query type: string description: Category on which restrict the search on services - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-database-service-clusterId path: /cloud/project/{serviceName}/database/service/{clusterId} operations: - name: get method: GET description: OVH Cloud Get service cluster properties outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: clusterId in: path type: string description: Cluster ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-flavor path: /cloud/project/{serviceName}/flavor operations: - name: get method: GET description: OVH Cloud Get flavors outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: region in: query type: string description: Flavor region - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-flavor-flavorId path: /cloud/project/{serviceName}/flavor/{flavorId} operations: - name: get method: GET description: OVH Cloud Get flavor outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: flavorId in: path type: string description: Flavor ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-image path: /cloud/project/{serviceName}/image operations: - name: get method: GET description: OVH Cloud Get images outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: flavorType in: query type: string description: Get compatible images with flavor type - name: osType in: query type: string description: Image OS - name: region in: query type: string description: Image region - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-image-imageId path: /cloud/project/{serviceName}/image/{imageId} operations: - name: get method: GET description: OVH Cloud Get image outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: imageId in: path type: string description: Image ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-instance path: /cloud/project/{serviceName}/instance operations: - name: get method: GET description: OVH Cloud Get instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: region in: query type: string description: Instance region - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-instance-bulk path: /cloud/project/{serviceName}/instance/bulk operations: - name: post method: POST description: OVH Cloud Create multiple instances outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-instance-group path: /cloud/project/{serviceName}/instance/group operations: - name: get method: GET description: OVH Cloud Get the detail of a group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: region in: query type: string description: Instance region - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-instance-group-groupId path: /cloud/project/{serviceName}/instance/group/{groupId} operations: - name: delete method: DELETE description: OVH Cloud Delete a group outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: groupId in: path type: string description: Group ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get all groups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: groupId in: path type: string description: Group ID required: true - name: region in: query type: string description: Instance region - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-instance-instanceId path: /cloud/project/{serviceName}/instance/{instanceId} operations: - name: delete method: DELETE description: OVH Cloud Delete an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Alter an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-instance-instanceId-activeMonthlyBilling path: /cloud/project/{serviceName}/instance/{instanceId}/activeMonthlyBilling operations: - name: post method: POST description: OVH Cloud Activate monthly billing on instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-instance-instanceId-applicationAccess path: /cloud/project/{serviceName}/instance/{instanceId}/applicationAccess operations: - name: post method: POST description: OVH Cloud Return initial credentials of applications installed from public image outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-instance-instanceId-interface path: /cloud/project/{serviceName}/instance/{instanceId}/interface operations: - name: get method: GET description: OVH Cloud Get interfaces outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create interface on an instance and attached it to a network outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-instance-instanceId-interface-interfaceId path: /cloud/project/{serviceName}/instance/{instanceId}/interface/{interfaceId} operations: - name: delete method: DELETE description: OVH Cloud Delete an interface outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: interfaceId in: path type: string description: Interface ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get interface outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: interfaceId in: path type: string description: Interface ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-instance-instanceId-monitoring path: /cloud/project/{serviceName}/instance/{instanceId}/monitoring operations: - name: get method: GET description: OVH Cloud Return many statistics about the virtual machine for a given period outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: period in: query type: string description: The period the statistics are fetched for required: true - name: serviceName in: path type: string description: Service name required: true - name: type in: query type: string description: The type of statistic to be fetched required: true - name: cloud-project-serviceName-instance-instanceId-reboot path: /cloud/project/{serviceName}/instance/{instanceId}/reboot operations: - name: post method: POST description: OVH Cloud Reboot an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-instance-instanceId-reinstall path: /cloud/project/{serviceName}/instance/{instanceId}/reinstall operations: - name: post method: POST description: OVH Cloud Reinstall an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-instance-instanceId-rescueMode path: /cloud/project/{serviceName}/instance/{instanceId}/rescueMode operations: - name: post method: POST description: OVH Cloud Enable or disable rescue mode outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-instance-instanceId-resize path: /cloud/project/{serviceName}/instance/{instanceId}/resize operations: - name: post method: POST description: OVH Cloud Migrate your instance to another flavor outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-instance-instanceId-resume path: /cloud/project/{serviceName}/instance/{instanceId}/resume operations: - name: post method: POST description: OVH Cloud Resume a suspended instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-instance-instanceId-shelve path: /cloud/project/{serviceName}/instance/{instanceId}/shelve operations: - name: post method: POST description: OVH Cloud Shelve an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-instance-instanceId-snapshot path: /cloud/project/{serviceName}/instance/{instanceId}/snapshot operations: - name: post method: POST description: OVH Cloud Snapshot an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-instance-instanceId-start path: /cloud/project/{serviceName}/instance/{instanceId}/start operations: - name: post method: POST description: OVH Cloud Start an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-instance-instanceId-stop path: /cloud/project/{serviceName}/instance/{instanceId}/stop operations: - name: post method: POST description: OVH Cloud Stop an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-instance-instanceId-unshelve path: /cloud/project/{serviceName}/instance/{instanceId}/unshelve operations: - name: post method: POST description: OVH Cloud Unshelve an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-instance-instanceId-vnc path: /cloud/project/{serviceName}/instance/{instanceId}/vnc operations: - name: post method: POST description: OVH Cloud Get VNC access to your instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-ip path: /cloud/project/{serviceName}/ip operations: - name: get method: GET description: OVH Cloud Get ips outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-ip-failover path: /cloud/project/{serviceName}/ip/failover operations: - name: get method: GET description: OVH Cloud Get failover ips outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-ip-failover-id path: /cloud/project/{serviceName}/ip/failover/{id} operations: - name: get method: GET description: OVH Cloud Get failover ip outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Id required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-ip-failover-id-attach path: /cloud/project/{serviceName}/ip/failover/{id}/attach operations: - name: post method: POST description: OVH Cloud Attach failover ip to an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Id required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube path: /cloud/project/{serviceName}/kube operations: - name: get method: GET description: OVH Cloud List your managed Kubernetes clusters outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new managed Kubernetes cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-regions path: /cloud/project/{serviceName}/kube/regions operations: - name: get method: GET description: OVH Cloud List Kubernetes available regions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-kube-kubeId path: /cloud/project/{serviceName}/kube/{kubeId} operations: - name: delete method: DELETE description: OVH Cloud Delete your managed Kubernetes cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get information about your managed Kubernetes cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update information about your managed Kubernetes cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-auditLogs path: /cloud/project/{serviceName}/kube/{kubeId}/auditLogs operations: - name: post method: POST description: OVH Cloud Generate a temporary URL to retrieve audit logs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-kube-kubeId-customization path: /cloud/project/{serviceName}/kube/{kubeId}/customization operations: - name: get method: GET description: OVH Cloud Get cluster customization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update cluster customization outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-flavors path: /cloud/project/{serviceName}/kube/{kubeId}/flavors operations: - name: get method: GET description: OVH Cloud List all flavors available outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-kube-kubeId-ipRestrictions path: /cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions operations: - name: get method: GET description: OVH Cloud List your ip restrictions on your cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Append a list of ip restrictions on your cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: put method: PUT description: OVH Cloud Remove the current list and add a list of ip restrictions on your cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-ipRestrictions-ip path: /cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions/{ip} operations: - name: delete method: DELETE description: OVH Cloud Delete an ip restriction from your cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ip in: path type: string description: Ip required: true - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-kube-kubeId-kubeconfig path: /cloud/project/{serviceName}/kube/{kubeId}/kubeconfig operations: - name: post method: POST description: OVH Cloud Generate kubeconfig file outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-kube-kubeId-kubeconfig-reset path: /cloud/project/{serviceName}/kube/{kubeId}/kubeconfig/reset operations: - name: post method: POST description: 'OVH Cloud Reset kubeconfig: Certificates will be regenerated, nodes will be reinstalled' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-kube-kubeId-log-url path: /cloud/project/{serviceName}/kube/{kubeId}/log/url operations: - name: post method: POST description: OVH Cloud Generate a temporary URL to retrieve logs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-metrics-etcdUsage path: /cloud/project/{serviceName}/kube/{kubeId}/metrics/etcdUsage operations: - name: get method: GET description: OVH Cloud List available metrics for this cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-kube-kubeId-node path: /cloud/project/{serviceName}/kube/{kubeId}/node operations: - name: get method: GET description: OVH Cloud List your nodes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-kube-kubeId-node-nodeId path: /cloud/project/{serviceName}/kube/{kubeId}/node/{nodeId} operations: - name: delete method: DELETE description: OVH Cloud Delete a specific node on your cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get information on a specific node on your cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: nodeId in: path type: string description: Node ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-kube-kubeId-nodepool path: /cloud/project/{serviceName}/kube/{kubeId}/nodepool operations: - name: get method: GET description: OVH Cloud List your nodepools outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a nodepool on your cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-nodepool-nodePoolId path: /cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId} operations: - name: delete method: DELETE description: OVH Cloud Delete a nodepool from your cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: nodePoolId in: path type: string description: Node pool ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get information on a specific nodepool on your cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: nodePoolId in: path type: string description: Node pool ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update your nodepool information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: nodePoolId in: path type: string description: Node pool ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-nodepool-nodePoolId-nodes path: /cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}/nodes operations: - name: get method: GET description: OVH Cloud List all nodes contained in a nodepool outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: nodePoolId in: path type: string description: Node pool ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-kube-kubeId-openIdConnect path: /cloud/project/{serviceName}/kube/{kubeId}/openIdConnect operations: - name: delete method: DELETE description: OVH Cloud Remove OpenIdConnect integration from APIServer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get openIdConnect integration parameters outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Configure APIServer for OpenIdConnect outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: put method: PUT description: OVH Cloud Update parameters and reconfigure APIServer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-privateNetworkConfiguration path: /cloud/project/{serviceName}/kube/{kubeId}/privateNetworkConfiguration operations: - name: get method: GET description: OVH Cloud Get private network configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update private network configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-reset path: /cloud/project/{serviceName}/kube/{kubeId}/reset operations: - name: post method: POST description: 'OVH Cloud Reset cluster: all Kubernetes data will be erased (pods, services, configuration, etc), nodes will be either deleted or reinstalled' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-restart path: /cloud/project/{serviceName}/kube/{kubeId}/restart operations: - name: post method: POST description: OVH Cloud Restarting your control plane apiserver to invalidate cache without downtime (using force will create a slight downtime) outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-update path: /cloud/project/{serviceName}/kube/{kubeId}/update operations: - name: post method: POST description: OVH Cloud Force cluster and node update to the latest patch within minor version or next minor version outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-updateLoadBalancersSubnetId path: /cloud/project/{serviceName}/kube/{kubeId}/updateLoadBalancersSubnetId operations: - name: put method: PUT description: OVH Cloud Updates the load balancers subnet ID outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-kube-kubeId-updatePolicy path: /cloud/project/{serviceName}/kube/{kubeId}/updatePolicy operations: - name: put method: PUT description: OVH Cloud Change the update policy of your cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: kubeId in: path type: string description: Kube ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-lab path: /cloud/project/{serviceName}/lab operations: - name: get method: GET description: OVH Cloud List available public cloud labs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-lab-labId path: /cloud/project/{serviceName}/lab/{labId} operations: - name: get method: GET description: OVH Cloud Get details of a public cloud lab outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: labId in: path type: string description: Lab ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Activate a lab on your Cloud Project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: labId in: path type: string description: Lab ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-lab-labId-agreement path: /cloud/project/{serviceName}/lab/{labId}/agreement operations: - name: get method: GET description: OVH Cloud List required agreements to active this lab outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: labId in: path type: string description: Lab ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-loadbalancer path: /cloud/project/{serviceName}/loadbalancer operations: - name: listloadbalancers method: GET description: OVH Cloud List all load balancer for a tenant outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: createloadbalancer method: POST description: OVH Cloud Create a load balancer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-loadbalancer-loadBalancerId path: /cloud/project/{serviceName}/loadbalancer/{loadBalancerId} operations: - name: deleteloadbalancer method: DELETE description: OVH Cloud Delete a load balancer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: serviceName in: path type: string description: Service name required: true - name: getloadbalancer method: GET description: OVH Cloud Get a load balancer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: serviceName in: path type: string description: Service name required: true - name: updateloadbalancer method: PUT description: OVH Cloud Update a load balancer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-loadbalancer-loadBalancerId-configuration path: /cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration operations: - name: listloadbalancerconfigurations method: GET description: OVH Cloud List all versions of the configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: serviceName in: path type: string description: Service name required: true - name: createloadbalancerconfiguration method: POST description: OVH Cloud Create a configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-loadbalancer-loadBalancerId-configuration-version path: /cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration/{version} operations: - name: deleteloadbalancerconfiguration method: DELETE description: OVH Cloud Delete a configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: serviceName in: path type: string description: Service name required: true - name: version in: path type: integer description: Version required: true - name: getloadbalancerconfiguration method: GET description: OVH Cloud Get a configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: serviceName in: path type: string description: Service name required: true - name: version in: path type: integer description: Version required: true - name: cloud-project-serviceName-loadbalancer-loadBalancerId-configuration-version-appl path: /cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration/{version}/apply operations: - name: applyloadbalancerconfiguration method: POST description: OVH Cloud Apply a configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: serviceName in: path type: string description: Service name required: true - name: version in: path type: integer description: Version required: true - name: cloud-project-serviceName-network-private path: /cloud/project/{serviceName}/network/private operations: - name: get method: GET description: OVH Cloud Get private networks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new network outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-network-private-networkId path: /cloud/project/{serviceName}/network/private/{networkId} operations: - name: delete method: DELETE description: OVH Cloud Delete private network outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get private network outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Rename private network outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-network-private-networkId-region path: /cloud/project/{serviceName}/network/private/{networkId}/region operations: - name: post method: POST description: OVH Cloud Activate private network in a new region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-network-private-networkId-subnet path: /cloud/project/{serviceName}/network/private/{networkId}/subnet operations: - name: get method: GET description: OVH Cloud Get network subnets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new network subnet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-network-private-networkId-subnet-subnetId path: /cloud/project/{serviceName}/network/private/{networkId}/subnet/{subnetId} operations: - name: delete method: DELETE description: OVH Cloud Delete a network subnet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: serviceName in: path type: string description: Service name required: true - name: subnetId in: path type: string description: Subnet ID required: true - name: cloud-project-serviceName-network-public path: /cloud/project/{serviceName}/network/public operations: - name: get method: GET description: OVH Cloud Get public networks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-operation path: /cloud/project/{serviceName}/operation operations: - name: get method: GET description: OVH Cloud List your operations outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-operation-operationId path: /cloud/project/{serviceName}/operation/{operationId} operations: - name: get method: GET description: OVH Cloud Get information about one operation outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: operationId in: path type: string description: Operation ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-quota path: /cloud/project/{serviceName}/quota operations: - name: get method: GET description: OVH Cloud List quotas outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region path: /cloud/project/{serviceName}/region operations: - name: get method: GET description: OVH Cloud List your regions outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Request access to a region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName path: /cloud/project/{serviceName}/region/{regionName} operations: - name: get method: GET description: OVH Cloud Get information about your region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-floatingip path: /cloud/project/{serviceName}/region/{regionName}/floatingip operations: - name: get method: GET description: OVH Cloud Get floating ips outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-floatingip-floatingIpId path: /cloud/project/{serviceName}/region/{regionName}/floatingip/{floatingIpId} operations: - name: delete method: DELETE description: OVH Cloud Delete a floating ip outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: floatingIpId in: path type: string description: Floating ip ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get a floating ip outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: floatingIpId in: path type: string description: Floating ip ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-floatingip-floatingIpId-detach path: /cloud/project/{serviceName}/region/{regionName}/floatingip/{floatingIpId}/detach operations: - name: post method: POST description: OVH Cloud Detach your floating ip outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: floatingIpId in: path type: string description: Floating ip ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-gateway path: /cloud/project/{serviceName}/region/{regionName}/gateway operations: - name: get method: GET description: OVH Cloud List gateways outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: subnetId in: query type: string description: Attached interface's subnet id - name: post method: POST description: OVH Cloud Create new Gateway and new Private Network with new Subnet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-gateway-id path: /cloud/project/{serviceName}/region/{regionName}/gateway/{id} operations: - name: delete method: DELETE description: OVH Cloud Delete gateway outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Id required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get gateway outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Id required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update a gateway outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Id required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-gateway-id-expose path: /cloud/project/{serviceName}/region/{regionName}/gateway/{id}/expose operations: - name: post method: POST description: OVH Cloud Expose gateway to public network by adding a public port on it. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Id required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-gateway-id-interface path: /cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface operations: - name: get method: GET description: OVH Cloud List interfaces outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Id required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create gateway interface outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Id required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-gateway-id-interface-interfaceId path: /cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface/{interfaceId} operations: - name: delete method: DELETE description: OVH Cloud Delete gateway interface outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Id required: true - name: interfaceId in: path type: string description: Interface ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get interface outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: string description: Id required: true - name: interfaceId in: path type: string description: Interface ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-instance-instanceId-abortSnapshot path: /cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/abortSnapshot operations: - name: post method: POST description: OVH Cloud Abort an instance snapshot creation outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-instance-instanceId-associateFloatin path: /cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/associateFloatingIp operations: - name: post method: POST description: OVH Cloud Associate an existing floating IP to an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-instance-instanceId-floatingIp path: /cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/floatingIp operations: - name: post method: POST description: OVH Cloud Create a floating IP and attach it to an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: instanceId in: path type: string description: Instance ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-keymanager-certificate path: /cloud/project/{serviceName}/region/{regionName}/keymanager/certificate operations: - name: get method: GET description: OVH Cloud List certificates outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new certificate outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-keymanager-certificate-certificateId path: /cloud/project/{serviceName}/region/{regionName}/keymanager/certificate/{certificateId} operations: - name: delete method: DELETE description: OVH Cloud Delete a certificate outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: certificateId in: path type: string description: Certificate ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get details about a certificate outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: certificateId in: path type: string description: Certificate ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-keymanager-secret path: /cloud/project/{serviceName}/region/{regionName}/keymanager/secret operations: - name: get method: GET description: OVH Cloud List secrets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-keymanager-secret-secretId path: /cloud/project/{serviceName}/region/{regionName}/keymanager/secret/{secretId} operations: - name: delete method: DELETE description: OVH Cloud Delete a secret outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: secretId in: path type: string description: Secret ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get details about a secret outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: secretId in: path type: string description: Secret ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-flavor path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/flavor operations: - name: get method: GET description: OVH Cloud List flavors outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-flavor-flavorId path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/flavor/{flavorId} operations: - name: get method: GET description: OVH Cloud Get details about a load balancing flavor outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: flavorId in: path type: string description: Flavor ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-healthMonitor path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor operations: - name: get method: GET description: OVH Cloud List health monitors outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poolId in: query type: string description: Linked pool id - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create health monitor outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-healthMonitor-healthMo path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor/{healthMonitorId} operations: - name: delete method: DELETE description: OVH Cloud Delete health monitor outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: healthMonitorId in: path type: string description: Health monitor ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get details about a loadbalancer health monitor outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: healthMonitorId in: path type: string description: Health monitor ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update a health monitor outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: healthMonitorId in: path type: string description: Health monitor ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-l7Policy path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy operations: - name: get method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: listenerId in: query type: string description: Linked listener id - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-l7Policy-l7PolicyId path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId} operations: - name: delete method: DELETE description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: l7PolicyId in: path type: string description: L7 policy ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: l7PolicyId in: path type: string description: L7 policy ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: l7PolicyId in: path type: string description: L7 policy ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-l7Policy-l7PolicyId-l7 path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule operations: - name: get method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: l7PolicyId in: path type: string description: L7 policy ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: l7PolicyId in: path type: string description: L7 policy ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-l7Policy-l7PolicyId-l7 path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId} operations: - name: delete method: DELETE description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: l7PolicyId in: path type: string description: L7 policy ID required: true - name: l7RuleId in: path type: string description: L7 rule ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: l7PolicyId in: path type: string description: L7 policy ID required: true - name: l7RuleId in: path type: string description: L7 rule ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: '' outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: l7PolicyId in: path type: string description: L7 policy ID required: true - name: l7RuleId in: path type: string description: L7 rule ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-listener path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener operations: - name: get method: GET description: OVH Cloud List your loadbalancer listeners outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadbalancerId in: query type: string description: Filter by loadbalancer - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a loadbalancer listener outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-listener-listenerId path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener/{listenerId} operations: - name: delete method: DELETE description: OVH Cloud Delete loadbalancer listener outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: listenerId in: path type: string description: Listener ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get details about a loadbalancer listener outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: listenerId in: path type: string description: Listener ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Edit a loadbalancer listener outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: listenerId in: path type: string description: Listener ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-loadbalancer path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer operations: - name: get method: GET description: OVH Cloud List your load balancers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a loadbalancer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-loadbalancer-loadBalan path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId} operations: - name: delete method: DELETE description: OVH Cloud Delete loadbalancer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get details about a load balancer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Edit a loadbalancer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-loadbalancer-loadBalan path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/associateFloatingIp operations: - name: post method: POST description: OVH Cloud Associate an existing floating IP to a loadbalancer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-loadbalancer-loadBalan path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/floatingIp operations: - name: post method: POST description: OVH Cloud Create a floating IP and attach it to a loadbalancer outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-loadbalancer-loadBalan path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/stats operations: - name: get method: GET description: OVH Cloud Get loadbalancer statistics outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadBalancerId in: path type: string description: Load balancer ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-pool path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool operations: - name: get method: GET description: OVH Cloud List your loadbalancer pools outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: loadbalancerId in: query type: string description: Filter by loadbalancer - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a loadbalancer pool outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-pool-poolId path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId} operations: - name: delete method: DELETE description: OVH Cloud Delete a loadbalancer pool outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poolId in: path type: string description: Pool ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get details about a loadbalancer pool outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poolId in: path type: string description: Pool ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update a loadbalancer pool outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poolId in: path type: string description: Pool ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-pool-poolId-member path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member operations: - name: get method: GET description: OVH Cloud List your pool members outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poolId in: path type: string description: Pool ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create pool members outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: poolId in: path type: string description: Pool ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-loadbalancing-pool-poolId-member-mem path: /cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member/{memberId} operations: - name: delete method: DELETE description: OVH Cloud Delete a pool member outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: memberId in: path type: string description: Member ID required: true - name: poolId in: path type: string description: Pool ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get details about a pool member outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: memberId in: path type: string description: Member ID required: true - name: poolId in: path type: string description: Pool ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update a pool member outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: memberId in: path type: string description: Member ID required: true - name: poolId in: path type: string description: Pool ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-network path: /cloud/project/{serviceName}/region/{regionName}/network operations: - name: get method: GET description: OVH Cloud List networks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a network with a gateway outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-network-networkId path: /cloud/project/{serviceName}/region/{regionName}/network/{networkId} operations: - name: delete method: DELETE description: OVH Cloud Delete network outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get network outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-network-networkId-subnet path: /cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet operations: - name: get method: GET description: OVH Cloud List subnets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-network-networkId-subnet-subnetId path: /cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId} operations: - name: delete method: DELETE description: OVH Cloud Delete subnet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: subnetId in: path type: string description: Subnet ID required: true - name: get method: GET description: OVH Cloud Get subnet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: subnetId in: path type: string description: Subnet ID required: true - name: cloud-project-serviceName-region-regionName-network-networkId-subnet-subnetId-ga path: /cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId}/gateway operations: - name: post method: POST description: OVH Cloud Create Gateway for existing subnet outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: networkId in: path type: string description: Network ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: subnetId in: path type: string description: Subnet ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-quota path: /cloud/project/{serviceName}/region/{regionName}/quota operations: - name: get method: GET description: OVH Cloud List quotas outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Change project quotas on region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-quota-allowed path: /cloud/project/{serviceName}/region/{regionName}/quota/allowed operations: - name: get method: GET description: OVH Cloud Get allowed quotas on region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-quota-storage path: /cloud/project/{serviceName}/region/{regionName}/quota/storage operations: - name: delete method: DELETE description: OVH Cloud Delete storage quota on region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get storage quotas on region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update storage quota on region outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-storage path: /cloud/project/{serviceName}/region/{regionName}/storage operations: - name: get method: GET description: OVH Cloud Get S3 storage containers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create S3 storage container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-storage-name path: /cloud/project/{serviceName}/region/{regionName}/storage/{name} operations: - name: delete method: DELETE description: OVH Cloud Delete S3 storage container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string description: Name required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get S3 storage container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: limit in: query type: integer description: Limit the number of objects returned (1000 maximum, defaults to 1000) - name: marker in: query type: string description: List objects whose names are greater than marker - name: name in: path type: string description: Name required: true - name: prefix in: query type: string description: Filter objects by name prefix - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update S3 storage container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string description: Name required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-storage-name-object-objectKey path: /cloud/project/{serviceName}/region/{regionName}/storage/{name}/object/{objectKey} operations: - name: delete method: DELETE description: OVH Cloud Delete S3 storage container object outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string description: Name required: true - name: objectKey in: path type: string description: Object key required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-region-regionName-storage-name-policy-userId path: /cloud/project/{serviceName}/region/{regionName}/storage/{name}/policy/{userId} operations: - name: post method: POST description: OVH Cloud Add S3 storage container policy outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string description: Name required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: string description: User ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-storage-name-presign path: /cloud/project/{serviceName}/region/{regionName}/storage/{name}/presign operations: - name: post method: POST description: OVH Cloud Generate S3 presigned URLs to download or upload objects outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: name in: path type: string description: Name required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-volumeBackup path: /cloud/project/{serviceName}/region/{regionName}/volumeBackup operations: - name: get method: GET description: OVH Cloud List volume backups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a volume backup outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-volumeBackup-volumeBackupId path: /cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId} operations: - name: delete method: DELETE description: OVH Cloud Delete volume backup outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: volumeBackupId in: path type: string description: Volume backup ID required: true - name: get method: GET description: OVH Cloud Get volume backup outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: volumeBackupId in: path type: string description: Volume backup ID required: true - name: cloud-project-serviceName-region-regionName-volumeBackup-volumeBackupId-restore path: /cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}/restore operations: - name: post method: POST description: OVH Cloud Restore a volume backup on a volume outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: volumeBackupId in: path type: string description: Volume backup ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-volumeBackup-volumeBackupId-volume path: /cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}/volume operations: - name: post method: POST description: OVH Cloud Create a volume from a volume backup outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: volumeBackupId in: path type: string description: Volume backup ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-workflow-backup path: /cloud/project/{serviceName}/region/{regionName}/workflow/backup operations: - name: get method: GET description: OVH Cloud List your automated backups outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a new automated backup outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-region-regionName-workflow-backup-backupWorkflowId path: /cloud/project/{serviceName}/region/{regionName}/workflow/backup/{backupWorkflowId} operations: - name: delete method: DELETE description: OVH Cloud Delete a backup workflow process outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: backupWorkflowId in: path type: string description: Backup workflow ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get details about a backup workflow process outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: backupWorkflowId in: path type: string description: Backup workflow ID required: true - name: regionName in: path type: string description: Region name required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-regionAvailable path: /cloud/project/{serviceName}/regionAvailable operations: - name: get method: GET description: OVH Cloud List the regions on which you can ask an access to outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-role path: /cloud/project/{serviceName}/role operations: - name: get method: GET description: OVH Cloud Get all Roles outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-serviceInfos path: /cloud/project/{serviceName}/serviceInfos operations: - name: get method: GET description: OVH Cloud Get service information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: The project id required: true - name: put method: PUT description: OVH Cloud Update service information outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: The project id required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-snapshot path: /cloud/project/{serviceName}/snapshot operations: - name: get method: GET description: OVH Cloud Get snapshots outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: flavorType in: query type: string description: Get compatible snapshots with flavor type - name: region in: query type: string description: Region - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-snapshot-imageId path: /cloud/project/{serviceName}/snapshot/{imageId} operations: - name: delete method: DELETE description: OVH Cloud Delete a snapshot outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: imageId in: path type: string description: Image ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get snapshot details outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: imageId in: path type: string description: Image ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-sshkey path: /cloud/project/{serviceName}/sshkey operations: - name: get method: GET description: OVH Cloud Get SSH keys outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: region in: query type: string description: Region - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create SSH key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-sshkey-keyId path: /cloud/project/{serviceName}/sshkey/{keyId} operations: - name: delete method: DELETE description: OVH Cloud Delete SSH key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: keyId in: path type: string description: Key ID required: true - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get SSH key outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: keyId in: path type: string description: Key ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-stack path: /cloud/project/{serviceName}/stack operations: - name: get method: GET description: OVH Cloud Get stacks outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-stack-stackId path: /cloud/project/{serviceName}/stack/{stackId} operations: - name: get method: GET description: OVH Cloud Get stack outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: stackId in: path type: string description: Stack ID required: true - name: cloud-project-serviceName-storage path: /cloud/project/{serviceName}/storage operations: - name: get method: GET description: OVH Cloud Get SWIFT storage containers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: includeType in: query type: boolean description: Include container type - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create SWIFT container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-storage-access path: /cloud/project/{serviceName}/storage/access operations: - name: post method: POST description: OVH Cloud Access to SWIFT storage API outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-storage-quota path: /cloud/project/{serviceName}/storage/quota operations: - name: get method: GET description: OVH Cloud List storage quotas outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-storage-containerId path: /cloud/project/{serviceName}/storage/{containerId} operations: - name: delete method: DELETE description: OVH Cloud Delete SWIFT container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: containerId in: path type: string description: Container ID required: true - name: recursive in: query type: boolean description: Recursively delete objects and container - name: serviceName in: path type: string description: Service name required: true - name: get method: GET description: OVH Cloud Get SWIFT storage container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: containerId in: path type: string description: Container ID required: true - name: noObjects in: query type: boolean description: Do not return container objects - name: prefix in: query type: string description: Filter objects by name prefix - name: serviceName in: path type: string description: Service name required: true - name: put method: PUT description: OVH Cloud Update SWIFT storage container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: containerId in: path type: string description: Container ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-storage-containerId-cors path: /cloud/project/{serviceName}/storage/{containerId}/cors operations: - name: delete method: DELETE description: OVH Cloud Delete CORS support on SWIFT container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: containerId in: path type: string description: Container ID required: true - name: origin in: query type: string description: Delete this origin required: true - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Add CORS support on SWIFT container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: containerId in: path type: string description: Container ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-storage-containerId-publicUrl path: /cloud/project/{serviceName}/storage/{containerId}/publicUrl operations: - name: post method: POST description: OVH Cloud Get a public temporary URL to access one of your SWIFT object outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: containerId in: path type: string description: Container ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-storage-containerId-static path: /cloud/project/{serviceName}/storage/{containerId}/static operations: - name: post method: POST description: OVH Cloud Deploy your SWIFT container files as a static web site outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: containerId in: path type: string description: Container ID required: true - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-storage-containerId-user path: /cloud/project/{serviceName}/storage/{containerId}/user operations: - name: post method: POST description: OVH Cloud Create openstack user with only access to this SWIFT container outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: containerId in: path type: string description: Container ID required: true - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-terminate path: /cloud/project/{serviceName}/terminate operations: - name: post method: POST description: OVH Cloud Ask for the termination of your service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: The project id required: true - name: cloud-project-serviceName-user path: /cloud/project/{serviceName}/user operations: - name: get method: GET description: OVH Cloud Get all users outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-user-userId path: /cloud/project/{serviceName}/user/{userId} operations: - name: delete method: DELETE description: OVH Cloud Delete user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: get method: GET description: OVH Cloud Get user details outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: cloud-project-serviceName-user-userId-configuration path: /cloud/project/{serviceName}/user/{userId}/configuration operations: - name: get method: GET description: OVH Cloud Get your client configuration outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: region in: query type: string description: Region - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: cloud-project-serviceName-user-userId-openrc path: /cloud/project/{serviceName}/user/{userId}/openrc operations: - name: get method: GET description: OVH Cloud Get RC file of OpenStack outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: region in: query type: string description: Region required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: version in: query type: string description: Identity API version - name: cloud-project-serviceName-user-userId-policy path: /cloud/project/{serviceName}/user/{userId}/policy operations: - name: get method: GET description: OVH Cloud Export user storage policy outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: post method: POST description: OVH Cloud Import user storage policy outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-user-userId-rclone path: /cloud/project/{serviceName}/user/{userId}/rclone operations: - name: get method: GET description: OVH Cloud Get rclone configuration file outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: region in: query type: string description: Region required: true - name: service in: query type: string description: Service - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: cloud-project-serviceName-user-userId-regeneratePassword path: /cloud/project/{serviceName}/user/{userId}/regeneratePassword operations: - name: post method: POST description: OVH Cloud Regenerate user password outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: cloud-project-serviceName-user-userId-role path: /cloud/project/{serviceName}/user/{userId}/role operations: - name: get method: GET description: OVH Cloud Get user roles outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: post method: POST description: OVH Cloud Add a role to a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: put method: PUT description: OVH Cloud Update roles of a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-user-userId-role-roleId path: /cloud/project/{serviceName}/user/{userId}/role/{roleId} operations: - name: delete method: DELETE description: OVH Cloud Remove role for a user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: roleId in: path type: string description: Role ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: get method: GET description: OVH Cloud Get role detail outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: roleId in: path type: string description: Role ID required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: cloud-project-serviceName-user-userId-s3Credentials path: /cloud/project/{serviceName}/user/{userId}/s3Credentials operations: - name: get method: GET description: OVH Cloud List your S3 credentials outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: post method: POST description: OVH Cloud Create a new S3 credentials for an user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: cloud-project-serviceName-user-userId-s3Credentials-access path: /cloud/project/{serviceName}/user/{userId}/s3Credentials/{access} operations: - name: delete method: DELETE description: OVH Cloud Delete an S3 credential outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: access in: path type: string description: Access required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: get method: GET description: OVH Cloud Get details about an S3 credential outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: access in: path type: string description: Access required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: cloud-project-serviceName-user-userId-s3Credentials-access-secret path: /cloud/project/{serviceName}/user/{userId}/s3Credentials/{access}/secret operations: - name: post method: POST description: OVH Cloud Display secret from a S3 credential outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: access in: path type: string description: Access required: true - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: cloud-project-serviceName-user-userId-token path: /cloud/project/{serviceName}/user/{userId}/token operations: - name: post method: POST description: OVH Cloud Get token for user outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: userId in: path type: integer description: User ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-volume path: /cloud/project/{serviceName}/volume operations: - name: get method: GET description: OVH Cloud Get volumes outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: region in: query type: string description: Volume region - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Create a volume outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-volume-snapshot path: /cloud/project/{serviceName}/volume/snapshot operations: - name: get method: GET description: OVH Cloud Get volume snapshots outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: region in: query type: string description: Snapshots region - name: serviceName in: path type: string description: Service name required: true - name: cloud-project-serviceName-volume-snapshot-snapshotId path: /cloud/project/{serviceName}/volume/snapshot/{snapshotId} operations: - name: delete method: DELETE description: OVH Cloud Delete a volume snapshot outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: snapshotId in: path type: string description: Snapshot ID required: true - name: get method: GET description: OVH Cloud Get volume snapshot details outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: snapshotId in: path type: string description: Snapshot ID required: true - name: cloud-project-serviceName-volume-volumeId path: /cloud/project/{serviceName}/volume/{volumeId} operations: - name: delete method: DELETE description: OVH Cloud Delete a volume outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: volumeId in: path type: string description: Volume ID required: true - name: get method: GET description: OVH Cloud Get volume details outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: volumeId in: path type: string description: Volume ID required: true - name: put method: PUT description: OVH Cloud Update a volume outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: volumeId in: path type: string description: Volume ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-volume-volumeId-attach path: /cloud/project/{serviceName}/volume/{volumeId}/attach operations: - name: post method: POST description: OVH Cloud Attach a volume on an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: volumeId in: path type: string description: Volume ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-volume-volumeId-detach path: /cloud/project/{serviceName}/volume/{volumeId}/detach operations: - name: post method: POST description: OVH Cloud Detach a volume from an instance outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: volumeId in: path type: string description: Volume ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-volume-volumeId-snapshot path: /cloud/project/{serviceName}/volume/{volumeId}/snapshot operations: - name: post method: POST description: OVH Cloud Snapshot a volume outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: volumeId in: path type: string description: Volume ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-volume-volumeId-upsize path: /cloud/project/{serviceName}/volume/{volumeId}/upsize operations: - name: post method: POST description: OVH Cloud Extend a volume outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: volumeId in: path type: string description: Volume ID required: true - name: body in: body type: object description: Request body (JSON). required: true - name: cloud-project-serviceName-vrack path: /cloud/project/{serviceName}/vrack operations: - name: get method: GET description: OVH Cloud Get the linked vRack on your project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true - name: post method: POST description: OVH Cloud Order and attach a new vRack on your project outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: serviceName in: path type: string description: Service name required: true authentication: type: bearer token: '{{env.OVH_CLOUD_API_KEY}}' exposes: - type: rest namespace: ovh-cloud-cloud-rest port: 8080 description: REST adapter for OVH Cloud OVHcloud API specification — Cloud. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/cloud/order name: cloud-order description: REST surface for cloud-order. operations: - method: GET name: get description: OVH Cloud Get all cloud pending orders call: ovh-cloud-cloud.get with: planCode: rest.planCode outputParameters: - type: object mapping: $. - path: /v1/cloud/order/rule/availability name: cloud-order-rule-availability description: REST surface for cloud-order-rule-availability. operations: - method: GET name: get description: OVH Cloud Get product availability call: ovh-cloud-cloud.get with: addonFamily: rest.addonFamily ovhSubsidiary: rest.ovhSubsidiary planCode: rest.planCode outputParameters: - type: object mapping: $. - path: /v1/cloud/order/rule/instancecategory name: cloud-order-rule-instancecategory description: REST surface for cloud-order-rule-instanceCategory. operations: - method: GET name: get description: OVH Cloud Get instance categories call: ovh-cloud-cloud.get outputParameters: - type: object mapping: $. - path: /v1/cloud/project name: cloud-project description: REST surface for cloud-project. operations: - method: GET name: get description: OVH Cloud List available services call: ovh-cloud-cloud.get with: iamTags: rest.iamTags outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename} name: cloud-project-servicename description: REST surface for cloud-project-serviceName. operations: - method: GET name: get description: OVH Cloud Get this object properties call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Alter this object properties call: ovh-cloud-cloud.put with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/activatemonthlybilling name: cloud-project-servicename-activatemonthlybilling description: REST surface for cloud-project-serviceName-activateMonthlyBilling. operations: - method: POST name: post description: OVH Cloud Activate monthly billing on multiple instances call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/capabilities/containerregistry name: cloud-project-servicename-capabilities-containerregistry description: REST surface for cloud-project-serviceName-capabilities-containerRegistry. operations: - method: GET name: get description: OVH Cloud List container registry capabilities per region call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/capabilities/kube/admissionplugins name: cloud-project-servicename-capabilities-kube-admissionplugins description: REST surface for cloud-project-serviceName-capabilities-kube-admissionplugins. operations: - method: GET name: get description: OVH Cloud List of admissionPlugins managed by MKS product that can be enabled or disabled. call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/capabilities/kube/flavors name: cloud-project-servicename-capabilities-kube-flavors description: REST surface for cloud-project-serviceName-capabilities-kube-flavors. operations: - method: GET name: get description: OVH Cloud List Kubernetes available flavors for a region call: ovh-cloud-cloud.get with: region: rest.region serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/capabilities/kube/log/kind name: cloud-project-servicename-capabilities-kube-log-kind description: REST surface for cloud-project-serviceName-capabilities-kube-log-kind. operations: - method: GET name: get description: OVH Cloud List available log kinds call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/capabilities/kube/log/kind/{name} name: cloud-project-servicename-capabilities-kube-log-kind-name description: REST surface for cloud-project-serviceName-capabilities-kube-log-kind-name. operations: - method: GET name: get description: OVH Cloud Get a log kind call: ovh-cloud-cloud.get with: name: rest.name serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/capabilities/kube/regions name: cloud-project-servicename-capabilities-kube-regions description: REST surface for cloud-project-serviceName-capabilities-kube-regions. operations: - method: GET name: get description: OVH Cloud List Kubernetes regions where cluster creation is possible. call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/capabilities/loadbalancer/region name: cloud-project-servicename-capabilities-loadbalancer-region description: REST surface for cloud-project-serviceName-capabilities-loadbalancer-region. operations: - method: GET name: get description: OVH Cloud List all available regions call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/capabilities/loadbalancer/region/{regionname} name: cloud-project-servicename-capabilities-loadbalancer-region-regionname description: REST surface for cloud-project-serviceName-capabilities-loadbalancer-region-regionName. operations: - method: GET name: get description: OVH Cloud Get specific information of a region call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/capabilities/productavailability name: cloud-project-servicename-capabilities-productavailability description: REST surface for cloud-project-serviceName-capabilities-productAvailability. operations: - method: GET name: get description: OVH Cloud List product availability call: ovh-cloud-cloud.get with: addonFamily: rest.addonFamily ovhSubsidiary: rest.ovhSubsidiary planCode: rest.planCode planFamily: rest.planFamily product: rest.product serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/confirmtermination name: cloud-project-servicename-confirmtermination description: REST surface for cloud-project-serviceName-confirmTermination. operations: - method: POST name: post description: OVH Cloud Confirm service termination call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/containerregistry name: cloud-project-servicename-containerregistry description: REST surface for cloud-project-serviceName-containerRegistry. operations: - method: GET name: get description: OVH Cloud List registries of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new registry call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/containerregistry/{registryid} name: cloud-project-servicename-containerregistry-registryid description: REST surface for cloud-project-serviceName-containerRegistry-registryID. operations: - method: DELETE name: delete description: OVH Cloud Delete a registry call: ovh-cloud-cloud.delete with: registryID: rest.registryID serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get the registry information call: ovh-cloud-cloud.get with: registryID: rest.registryID serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update the registry call: ovh-cloud-cloud.put with: registryID: rest.registryID serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/containerregistry/{registryid}/capabilities/plan name: cloud-project-servicename-containerregistry-registryid-capabilities-plan description: REST surface for cloud-project-serviceName-containerRegistry-registryID-capabilities-plan. operations: - method: GET name: get description: OVH Cloud Get available plans for the current registry. call: ovh-cloud-cloud.get with: registryID: rest.registryID serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/containerregistry/{registryid}/iprestrictions/management name: cloud-project-servicename-containerregistry-registryid-iprestrictions-management description: REST surface for cloud-project-serviceName-containerRegistry-registryID-ipRestrictions-management. operations: - method: GET name: get description: OVH Cloud List your IP restrictions applied on Harbor UI and API call: ovh-cloud-cloud.get with: registryID: rest.registryID serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Replace IP restrictions applied on Harbor UI and API call: ovh-cloud-cloud.put with: registryID: rest.registryID serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/containerregistry/{registryid}/iprestrictions/registry name: cloud-project-servicename-containerregistry-registryid-iprestrictions-registry description: REST surface for cloud-project-serviceName-containerRegistry-registryID-ipRestrictions-registry. operations: - method: GET name: get description: OVH Cloud List your IP restrictions applied on artifact manager component call: ovh-cloud-cloud.get with: registryID: rest.registryID serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Replace IP restrictions applied on artifact manager component (Docker, Helm, etc...) call: ovh-cloud-cloud.put with: registryID: rest.registryID serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/containerregistry/{registryid}/openidconnect name: cloud-project-servicename-containerregistry-registryid-openidconnect description: REST surface for cloud-project-serviceName-containerRegistry-registryID-openIdConnect. operations: - method: DELETE name: delete description: OVH Cloud Delete the registry's OIDC Configuration call: ovh-cloud-cloud.delete with: registryID: rest.registryID serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get the registry's OIDC configuration call: ovh-cloud-cloud.get with: registryID: rest.registryID serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add or replace the registry's OIDC configuration call: ovh-cloud-cloud.post with: registryID: rest.registryID serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Edit the registry's OIDC configuration call: ovh-cloud-cloud.put with: registryID: rest.registryID serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/containerregistry/{registryid}/plan name: cloud-project-servicename-containerregistry-registryid-plan description: REST surface for cloud-project-serviceName-containerRegistry-registryID-plan. operations: - method: GET name: get description: OVH Cloud Show the actual plan of the registry. call: ovh-cloud-cloud.get with: registryID: rest.registryID serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update the plan of a registry. call: ovh-cloud-cloud.put with: registryID: rest.registryID serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/containerregistry/{registryid}/users name: cloud-project-servicename-containerregistry-registryid-users description: REST surface for cloud-project-serviceName-containerRegistry-registryID-users. operations: - method: GET name: get description: OVH Cloud List registry user call: ovh-cloud-cloud.get with: registryID: rest.registryID serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new registry user call: ovh-cloud-cloud.post with: registryID: rest.registryID serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/containerregistry/{registryid}/users/{userid} name: cloud-project-servicename-containerregistry-registryid-users-userid description: REST surface for cloud-project-serviceName-containerRegistry-registryID-users-userID. operations: - method: DELETE name: delete description: OVH Cloud Delete a registry user call: ovh-cloud-cloud.delete with: registryID: rest.registryID serviceName: rest.serviceName userID: rest.userID outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get registry user call: ovh-cloud-cloud.get with: registryID: rest.registryID serviceName: rest.serviceName userID: rest.userID outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/containerregistry/{registryid}/users/{userid}/setasadmin name: cloud-project-servicename-containerregistry-registryid-users-userid-setasadmin description: REST surface for cloud-project-serviceName-containerRegistry-registryID-users-userID-setAsAdmin. operations: - method: PUT name: put description: OVH Cloud Set the user as Admin call: ovh-cloud-cloud.put with: registryID: rest.registryID serviceName: rest.serviceName userID: rest.userID outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/availability name: cloud-project-servicename-database-availability description: REST surface for cloud-project-serviceName-database-availability. operations: - method: GET name: get description: OVH Cloud Get database engines availability call: ovh-cloud-cloud.get with: action: rest.action clusterId: rest.clusterId serviceName: rest.serviceName target: rest.target outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/capabilities name: cloud-project-servicename-database-capabilities description: REST surface for cloud-project-serviceName-database-capabilities. operations: - method: GET name: get description: OVH Cloud Get database engines capabilities call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra name: cloud-project-servicename-database-cassandra description: REST surface for cloud-project-serviceName-database-cassandra. operations: - method: GET name: get description: OVH Cloud List all the cassandra clusters of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new cassandra cluster call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid} name: cloud-project-servicename-database-cassandra-clusterid description: REST surface for cloud-project-serviceName-database-cassandra-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a cassandra cluster call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get cassandra cluster properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing cassandra cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/advancedconfiguration name: cloud-project-servicename-database-cassandra-clusterid-advancedconfiguration description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-advancedConfiguration. operations: - method: GET name: get description: OVH Cloud Get cassandra advanced configuration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update cassandra advanced configuration call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/backup name: cloud-project-servicename-database-cassandra-clusterid-backup description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-backup. operations: - method: GET name: get description: OVH Cloud List backups of the cassandra call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/backup/{backupid} name: cloud-project-servicename-database-cassandra-clusterid-backup-backupid description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-backup-backupId. operations: - method: GET name: get description: OVH Cloud Get cassandra backups call: ovh-cloud-cloud.get with: backupId: rest.backupId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/capabilities/advancedconfiguration name: cloud-project-servicename-database-cassandra-clusterid-capabilities-advancedconf description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-capabilities-advancedConf. operations: - method: GET name: get description: OVH Cloud Get cassandra advanced configuration fields call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/capabilities/integration name: cloud-project-servicename-database-cassandra-clusterid-capabilities-integration description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-capabilities-integration. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the cassandra service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/certificates name: cloud-project-servicename-database-cassandra-clusterid-certificates description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-certificates. operations: - method: GET name: get description: OVH Cloud Retrieve the certificates of the cassandra cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/integration name: cloud-project-servicename-database-cassandra-clusterid-integration description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-cassandra-clusterid-integration-integrationid description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-integration-integrationId. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/iprestriction name: cloud-project-servicename-database-cassandra-clusterid-iprestriction description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-ipRestriction. operations: - method: GET name: get description: OVH Cloud List cassandra ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add ip restrictions to the cassandra call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/iprestriction/{ipblock} name: cloud-project-servicename-database-cassandra-clusterid-iprestriction-ipblock description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-ipRestriction-ipBlock. operations: - method: DELETE name: delete description: OVH Cloud Deletes the given IP from the restricted IPs of the cassandra call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get cassandra ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Changes the list of ip restrictions to the cassandra call: ovh-cloud-cloud.put with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/logs name: cloud-project-servicename-database-cassandra-clusterid-logs description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent cassandra log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/maintenance name: cloud-project-servicename-database-cassandra-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the cassandra cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-cassandra-clusterid-maintenance-maintenanceid description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-maintenance-maintenanceId. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the cassandra cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-cassandra-clusterid-maintenance-maintenanceid description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-maintenance-maintenanceId. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/metric name: cloud-project-servicename-database-cassandra-clusterid-metric description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the cassandra cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-cassandra-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the cassandra cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/node name: cloud-project-servicename-database-cassandra-clusterid-node description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the cassandra call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-cassandra-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get cassandra nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/user name: cloud-project-servicename-database-cassandra-clusterid-user description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-user. operations: - method: GET name: get description: OVH Cloud List users of the cassandra call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new user on the cassandra cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/user/{userid} name: cloud-project-servicename-database-cassandra-clusterid-user-userid description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-user-userId. operations: - method: DELETE name: delete description: OVH Cloud Delete a cassandra user call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get cassandra users call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/cassandra/{clusterid}/user/{userid}/credentials/reset name: cloud-project-servicename-database-cassandra-clusterid-user-userid-credentials-r description: REST surface for cloud-project-serviceName-database-cassandra-clusterId-user-userId-credentials-r. operations: - method: POST name: post description: OVH Cloud Resets the password of a user call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana name: cloud-project-servicename-database-grafana description: REST surface for cloud-project-serviceName-database-grafana. operations: - method: GET name: get description: OVH Cloud List all the grafana of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new grafana cluster call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid} name: cloud-project-servicename-database-grafana-clusterid description: REST surface for cloud-project-serviceName-database-grafana-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a grafana cluster call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get grafana cluster properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing grafana cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/advancedconfiguration name: cloud-project-servicename-database-grafana-clusterid-advancedconfiguration description: REST surface for cloud-project-serviceName-database-grafana-clusterId-advancedConfiguration. operations: - method: GET name: get description: OVH Cloud Get grafana advanced configuration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update grafana advanced configuration call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/backup name: cloud-project-servicename-database-grafana-clusterid-backup description: REST surface for cloud-project-serviceName-database-grafana-clusterId-backup. operations: - method: GET name: get description: OVH Cloud List backups of the grafana call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/backup/{backupid} name: cloud-project-servicename-database-grafana-clusterid-backup-backupid description: REST surface for cloud-project-serviceName-database-grafana-clusterId-backup-backupId. operations: - method: GET name: get description: OVH Cloud Get grafana backups call: ovh-cloud-cloud.get with: backupId: rest.backupId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/capabilities/advancedconfiguration name: cloud-project-servicename-database-grafana-clusterid-capabilities-advancedconfig description: REST surface for cloud-project-serviceName-database-grafana-clusterId-capabilities-advancedConfig. operations: - method: GET name: get description: OVH Cloud Get grafana advanced configuration fields call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/capabilities/integration name: cloud-project-servicename-database-grafana-clusterid-capabilities-integration description: REST surface for cloud-project-serviceName-database-grafana-clusterId-capabilities-integration. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the grafana service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/integration name: cloud-project-servicename-database-grafana-clusterid-integration description: REST surface for cloud-project-serviceName-database-grafana-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-grafana-clusterid-integration-integrationid description: REST surface for cloud-project-serviceName-database-grafana-clusterId-integration-integrationId. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/iprestriction name: cloud-project-servicename-database-grafana-clusterid-iprestriction description: REST surface for cloud-project-serviceName-database-grafana-clusterId-ipRestriction. operations: - method: GET name: get description: OVH Cloud List grafana ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add ip restrictions to the grafana call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/iprestriction/{ipblock} name: cloud-project-servicename-database-grafana-clusterid-iprestriction-ipblock description: REST surface for cloud-project-serviceName-database-grafana-clusterId-ipRestriction-ipBlock. operations: - method: DELETE name: delete description: OVH Cloud Deletes the given IP from the restricted IPs of the grafana call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get grafana ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Changes the list of ip restrictions to the grafana call: ovh-cloud-cloud.put with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/logs name: cloud-project-servicename-database-grafana-clusterid-logs description: REST surface for cloud-project-serviceName-database-grafana-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent grafana log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/maintenance name: cloud-project-servicename-database-grafana-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-grafana-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the grafana cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-grafana-clusterid-maintenance-maintenanceid description: REST surface for cloud-project-serviceName-database-grafana-clusterId-maintenance-maintenanceId. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the grafana cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-grafana-clusterid-maintenance-maintenanceid-a description: REST surface for cloud-project-serviceName-database-grafana-clusterId-maintenance-maintenanceId-a. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/metric name: cloud-project-servicename-database-grafana-clusterid-metric description: REST surface for cloud-project-serviceName-database-grafana-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the grafana cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-grafana-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-grafana-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the grafana cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/node name: cloud-project-servicename-database-grafana-clusterid-node description: REST surface for cloud-project-serviceName-database-grafana-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the grafana call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-grafana-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-grafana-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get grafana nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/user name: cloud-project-servicename-database-grafana-clusterid-user description: REST surface for cloud-project-serviceName-database-grafana-clusterId-user. operations: - method: GET name: get description: OVH Cloud List users of the grafana call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/user/{userid} name: cloud-project-servicename-database-grafana-clusterid-user-userid description: REST surface for cloud-project-serviceName-database-grafana-clusterId-user-userId. operations: - method: GET name: get description: OVH Cloud Get grafana users call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/grafana/{clusterid}/user/{userid}/credentials/reset name: cloud-project-servicename-database-grafana-clusterid-user-userid-credentials-res description: REST surface for cloud-project-serviceName-database-grafana-clusterId-user-userId-credentials-res. operations: - method: POST name: post description: OVH Cloud Resets the password of a user call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka name: cloud-project-servicename-database-kafka description: REST surface for cloud-project-serviceName-database-kafka. operations: - method: GET name: get description: OVH Cloud List all the kafka of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new kafka cluster call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid} name: cloud-project-servicename-database-kafka-clusterid description: REST surface for cloud-project-serviceName-database-kafka-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a kafka cluster call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafka cluster properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing kafka cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/acl name: cloud-project-servicename-database-kafka-clusterid-acl description: REST surface for cloud-project-serviceName-database-kafka-clusterId-acl. operations: - method: GET name: get description: OVH Cloud List acls of the kafka call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new acl on the kafka cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/acl/{aclid} name: cloud-project-servicename-database-kafka-clusterid-acl-aclid description: REST surface for cloud-project-serviceName-database-kafka-clusterId-acl-aclId. operations: - method: DELETE name: delete description: OVH Cloud Delete a kafka acl call: ovh-cloud-cloud.delete with: aclId: rest.aclId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafka acls call: ovh-cloud-cloud.get with: aclId: rest.aclId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/advancedconfiguration name: cloud-project-servicename-database-kafka-clusterid-advancedconfiguration description: REST surface for cloud-project-serviceName-database-kafka-clusterId-advancedConfiguration. operations: - method: GET name: get description: OVH Cloud Get kafka advanced configuration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update kafka advanced configuration call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/capabilities/advancedconfiguration name: cloud-project-servicename-database-kafka-clusterid-capabilities-advancedconfigur description: REST surface for cloud-project-serviceName-database-kafka-clusterId-capabilities-advancedConfigur. operations: - method: GET name: get description: OVH Cloud Get kafka advanced configuration fields call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/capabilities/integration name: cloud-project-servicename-database-kafka-clusterid-capabilities-integration description: REST surface for cloud-project-serviceName-database-kafka-clusterId-capabilities-integration. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the kafka service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/certificates name: cloud-project-servicename-database-kafka-clusterid-certificates description: REST surface for cloud-project-serviceName-database-kafka-clusterId-certificates. operations: - method: GET name: get description: OVH Cloud Retrieve the certificates of the kafka cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/integration name: cloud-project-servicename-database-kafka-clusterid-integration description: REST surface for cloud-project-serviceName-database-kafka-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-kafka-clusterid-integration-integrationid description: REST surface for cloud-project-serviceName-database-kafka-clusterId-integration-integrationId. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/iprestriction name: cloud-project-servicename-database-kafka-clusterid-iprestriction description: REST surface for cloud-project-serviceName-database-kafka-clusterId-ipRestriction. operations: - method: GET name: get description: OVH Cloud List kafka ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add ip restrictions to the kafka call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/iprestriction/{ipblock} name: cloud-project-servicename-database-kafka-clusterid-iprestriction-ipblock description: REST surface for cloud-project-serviceName-database-kafka-clusterId-ipRestriction-ipBlock. operations: - method: DELETE name: delete description: OVH Cloud Deletes the given IP from the restricted IPs of the kafka call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafka ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Changes the list of ip restrictions to the kafka call: ovh-cloud-cloud.put with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/logs name: cloud-project-servicename-database-kafka-clusterid-logs description: REST surface for cloud-project-serviceName-database-kafka-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent kafka log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/maintenance name: cloud-project-servicename-database-kafka-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-kafka-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the kafka cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-kafka-clusterid-maintenance-maintenanceid description: REST surface for cloud-project-serviceName-database-kafka-clusterId-maintenance-maintenanceId. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the kafka cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-kafka-clusterid-maintenance-maintenanceid-app description: REST surface for cloud-project-serviceName-database-kafka-clusterId-maintenance-maintenanceId-app. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/metric name: cloud-project-servicename-database-kafka-clusterid-metric description: REST surface for cloud-project-serviceName-database-kafka-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the kafka cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-kafka-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-kafka-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the kafka cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/node name: cloud-project-servicename-database-kafka-clusterid-node description: REST surface for cloud-project-serviceName-database-kafka-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the kafka call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-kafka-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-kafka-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get kafka nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/permissions name: cloud-project-servicename-database-kafka-clusterid-permissions description: REST surface for cloud-project-serviceName-database-kafka-clusterId-permissions. operations: - method: GET name: get description: OVH Cloud Retrieve the permissions available on the cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/schemaregistryacl name: cloud-project-servicename-database-kafka-clusterid-schemaregistryacl description: REST surface for cloud-project-serviceName-database-kafka-clusterId-schemaRegistryAcl. operations: - method: GET name: get description: OVH Cloud List schema registry acls of the kafka call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new schema registry acl on the kafka cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/schemaregistryacl/{aclid} name: cloud-project-servicename-database-kafka-clusterid-schemaregistryacl-aclid description: REST surface for cloud-project-serviceName-database-kafka-clusterId-schemaRegistryAcl-aclId. operations: - method: DELETE name: delete description: OVH Cloud Delete a kafka schema registry acl call: ovh-cloud-cloud.delete with: aclId: rest.aclId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafka schema registry acls call: ovh-cloud-cloud.get with: aclId: rest.aclId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/topic name: cloud-project-servicename-database-kafka-clusterid-topic description: REST surface for cloud-project-serviceName-database-kafka-clusterId-topic. operations: - method: GET name: get description: OVH Cloud List topics of the kafka call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new topic on the kafka cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/topic/{topicid} name: cloud-project-servicename-database-kafka-clusterid-topic-topicid description: REST surface for cloud-project-serviceName-database-kafka-clusterId-topic-topicId. operations: - method: DELETE name: delete description: OVH Cloud Delete a kafka topic call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName topicId: rest.topicId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafka topics call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName topicId: rest.topicId outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Updates the topic on the kafka cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName topicId: rest.topicId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/topicacl name: cloud-project-servicename-database-kafka-clusterid-topicacl description: REST surface for cloud-project-serviceName-database-kafka-clusterId-topicAcl. operations: - method: GET name: get description: OVH Cloud List topic acls of the kafka call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new topic acl on the kafka cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/topicacl/{aclid} name: cloud-project-servicename-database-kafka-clusterid-topicacl-aclid description: REST surface for cloud-project-serviceName-database-kafka-clusterId-topicAcl-aclId. operations: - method: DELETE name: delete description: OVH Cloud Delete a kafka topic acl call: ovh-cloud-cloud.delete with: aclId: rest.aclId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafka topic acls call: ovh-cloud-cloud.get with: aclId: rest.aclId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/user name: cloud-project-servicename-database-kafka-clusterid-user description: REST surface for cloud-project-serviceName-database-kafka-clusterId-user. operations: - method: GET name: get description: OVH Cloud List users of the kafka call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new user on the kafka cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/user/{userid} name: cloud-project-servicename-database-kafka-clusterid-user-userid description: REST surface for cloud-project-serviceName-database-kafka-clusterId-user-userId. operations: - method: DELETE name: delete description: OVH Cloud Delete a kafka user call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafka users call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/user/{userid}/access name: cloud-project-servicename-database-kafka-clusterid-user-userid-access description: REST surface for cloud-project-serviceName-database-kafka-clusterId-user-userId-access. operations: - method: GET name: get description: OVH Cloud Retrieve the user acces for the cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafka/{clusterid}/user/{userid}/credentials/reset name: cloud-project-servicename-database-kafka-clusterid-user-userid-credentials-reset description: REST surface for cloud-project-serviceName-database-kafka-clusterId-user-userId-credentials-reset. operations: - method: POST name: post description: OVH Cloud Resets the password of a user call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect name: cloud-project-servicename-database-kafkaconnect description: REST surface for cloud-project-serviceName-database-kafkaConnect. operations: - method: GET name: get description: OVH Cloud List all the kafkaConnect of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new kafkaConnect cluster call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid} name: cloud-project-servicename-database-kafkaconnect-clusterid description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a kafkaConnect cluster call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafkaConnect cluster properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing kafkaConnect cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/advancedconfiguration name: cloud-project-servicename-database-kafkaconnect-clusterid-advancedconfiguration description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-advancedConfiguration. operations: - method: GET name: get description: OVH Cloud Get kafkaConnect advanced configuration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update kafkaConnect advanced configuration call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/capabilities/advancedconfiguration name: cloud-project-servicename-database-kafkaconnect-clusterid-capabilities-advancedc description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-advancedC. operations: - method: GET name: get description: OVH Cloud Get kafkaConnect advanced configuration fields call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/capabilities/connector name: cloud-project-servicename-database-kafkaconnect-clusterid-capabilities-connector description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-connector. operations: - method: GET name: get description: OVH Cloud List Kafka Connect connectors call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/capabilities/connector/{connectorid} name: cloud-project-servicename-database-kafkaconnect-clusterid-capabilities-connector description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-connector. operations: - method: GET name: get description: OVH Cloud Get Kafka Connect connector capability call: ovh-cloud-cloud.get with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/capabilities/connector/{connectorid}/configuration name: cloud-project-servicename-database-kafkaconnect-clusterid-capabilities-connector description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-connector. operations: - method: GET name: get description: OVH Cloud Get Kafka Connect connector configuration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/capabilities/connector/{connectorid}/transforms name: cloud-project-servicename-database-kafkaconnect-clusterid-capabilities-connector description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-connector. operations: - method: GET name: get description: OVH Cloud Get Kafka Connect connector transforms call: ovh-cloud-cloud.get with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/capabilities/integration name: cloud-project-servicename-database-kafkaconnect-clusterid-capabilities-integrati description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-capabilities-integrati. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the kafkaConnect service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/connector name: cloud-project-servicename-database-kafkaconnect-clusterid-connector description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-connector. operations: - method: GET name: get description: OVH Cloud List the connectors call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new connector call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/connector/{connectorid} name: cloud-project-servicename-database-kafkaconnect-clusterid-connector-connectorid description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId. operations: - method: DELETE name: delete description: OVH Cloud Delete a connector call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get connector call: ovh-cloud-cloud.get with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update a connector call: ovh-cloud-cloud.put with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/connector/{connectorid}/pause name: cloud-project-servicename-database-kafkaconnect-clusterid-connector-connectorid description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId-. operations: - method: POST name: post description: OVH Cloud Pause the kafka connector execution call: ovh-cloud-cloud.post with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/connector/{connectorid}/restart name: cloud-project-servicename-database-kafkaconnect-clusterid-connector-connectorid description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId-. operations: - method: POST name: post description: OVH Cloud Restart the kafka connector execution call: ovh-cloud-cloud.post with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/connector/{connectorid}/resume name: cloud-project-servicename-database-kafkaconnect-clusterid-connector-connectorid description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId-. operations: - method: POST name: post description: OVH Cloud Resume the kafka connector execution call: ovh-cloud-cloud.post with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/connector/{connectorid}/task name: cloud-project-servicename-database-kafkaconnect-clusterid-connector-connectorid description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId-. operations: - method: GET name: get description: OVH Cloud List the connector tasks call: ovh-cloud-cloud.get with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/connector/{connectorid}/task/{taskid} name: cloud-project-servicename-database-kafkaconnect-clusterid-connector-connectorid description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId-. operations: - method: GET name: get description: OVH Cloud Get connector task call: ovh-cloud-cloud.get with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName taskId: rest.taskId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/connector/{connectorid}/task/{taskid}/restart name: cloud-project-servicename-database-kafkaconnect-clusterid-connector-connectorid description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-connector-connectorId-. operations: - method: POST name: post description: OVH Cloud Restart the kafka connector task execution call: ovh-cloud-cloud.post with: clusterId: rest.clusterId connectorId: rest.connectorId serviceName: rest.serviceName taskId: rest.taskId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/integration name: cloud-project-servicename-database-kafkaconnect-clusterid-integration description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-kafkaconnect-clusterid-integration-integratio description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-integration-integratio. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/iprestriction name: cloud-project-servicename-database-kafkaconnect-clusterid-iprestriction description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-ipRestriction. operations: - method: GET name: get description: OVH Cloud List kafkaConnect ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add ip restrictions to the kafkaConnect call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/iprestriction/{ipblock} name: cloud-project-servicename-database-kafkaconnect-clusterid-iprestriction-ipblock description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-ipRestriction-ipBlock. operations: - method: DELETE name: delete description: OVH Cloud Deletes the given IP from the restricted IPs of the kafkaConnect call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafkaConnect ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Changes the list of ip restrictions to the kafkaConnect call: ovh-cloud-cloud.put with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/logs name: cloud-project-servicename-database-kafkaconnect-clusterid-logs description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent kafkaConnect log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/maintenance name: cloud-project-servicename-database-kafkaconnect-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the kafka connect cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-kafkaconnect-clusterid-maintenance-maintenanc description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-maintenance-maintenanc. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the kafka connect cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-kafkaconnect-clusterid-maintenance-maintenanc description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-maintenance-maintenanc. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/metric name: cloud-project-servicename-database-kafkaconnect-clusterid-metric description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the kafkaConnect cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-kafkaconnect-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the kafkaConnect cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/node name: cloud-project-servicename-database-kafkaconnect-clusterid-node description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the kafkaConnect call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-kafkaconnect-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get kafkaConnect nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/user name: cloud-project-servicename-database-kafkaconnect-clusterid-user description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-user. operations: - method: GET name: get description: OVH Cloud List users of the kafkaConnect call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new user on the kafkaConnect cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/user/{userid} name: cloud-project-servicename-database-kafkaconnect-clusterid-user-userid description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-user-userId. operations: - method: DELETE name: delete description: OVH Cloud Delete a kafkaConnect user call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafkaConnect users call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkaconnect/{clusterid}/user/{userid}/credentials/reset name: cloud-project-servicename-database-kafkaconnect-clusterid-user-userid-credential description: REST surface for cloud-project-serviceName-database-kafkaConnect-clusterId-user-userId-credential. operations: - method: POST name: post description: OVH Cloud Resets the password of a user call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker name: cloud-project-servicename-database-kafkamirrormaker description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker. operations: - method: GET name: get description: OVH Cloud List all the kafkaMirrorMaker of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new kafkaMirrorMaker call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid} name: cloud-project-servicename-database-kafkamirrormaker-clusterid description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a kafkaMirrorMaker call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafkaMirrorMaker properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing kafkaMirrorMaker call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/capabilities/integration name: cloud-project-servicename-database-kafkamirrormaker-clusterid-capabilities-integ description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-capabilities-integ. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the kafkaMirrorMaker service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/integration name: cloud-project-servicename-database-kafkamirrormaker-clusterid-integration description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-kafkamirrormaker-clusterid-integration-integr description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-integration-integr. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/logs name: cloud-project-servicename-database-kafkamirrormaker-clusterid-logs description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent kafkaMirrorMaker log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/maintenance name: cloud-project-servicename-database-kafkamirrormaker-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the kafka mirror maker cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-kafkamirrormaker-clusterid-maintenance-mainte description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-maintenance-mainte. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the kafka mirror maker cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-kafkamirrormaker-clusterid-maintenance-mainte description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-maintenance-mainte. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/metric name: cloud-project-servicename-database-kafkamirrormaker-clusterid-metric description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the kafkaMirrorMaker call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-kafkamirrormaker-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the kafkaMirrorMaker call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/node name: cloud-project-servicename-database-kafkamirrormaker-clusterid-node description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the kafkaMirrorMaker call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-kafkamirrormaker-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get kafkaMirrorMaker nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/replication name: cloud-project-servicename-database-kafkamirrormaker-clusterid-replication description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-replication. operations: - method: GET name: get description: OVH Cloud List replication of the kafkaMirrorMaker call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new replication call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/kafkamirrormaker/{clusterid}/replication/{replicationid} name: cloud-project-servicename-database-kafkamirrormaker-clusterid-replication-replic description: REST surface for cloud-project-serviceName-database-kafkaMirrorMaker-clusterId-replication-replic. operations: - method: DELETE name: delete description: OVH Cloud Delete an replication call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId replicationId: rest.replicationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get kafkaMirrorMaker replication call: ovh-cloud-cloud.get with: clusterId: rest.clusterId replicationId: rest.replicationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Updates a replication call: ovh-cloud-cloud.put with: clusterId: rest.clusterId replicationId: rest.replicationId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator name: cloud-project-servicename-database-m3aggregator description: REST surface for cloud-project-serviceName-database-m3aggregator. operations: - method: GET name: get description: OVH Cloud List all the m3aggregator of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new m3aggregator call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid} name: cloud-project-servicename-database-m3aggregator-clusterid description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a m3aggregator call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get m3aggregator properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing m3aggregator call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/capabilities/integration name: cloud-project-servicename-database-m3aggregator-clusterid-capabilities-integrati description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-capabilities-integrati. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the m3aggregator service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/integration name: cloud-project-servicename-database-m3aggregator-clusterid-integration description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-m3aggregator-clusterid-integration-integratio description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-integration-integratio. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/logs name: cloud-project-servicename-database-m3aggregator-clusterid-logs description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent m3aggregator log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/maintenance name: cloud-project-servicename-database-m3aggregator-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the m3aggregator cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-m3aggregator-clusterid-maintenance-maintenanc description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-maintenance-maintenanc. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the m3aggregator cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-m3aggregator-clusterid-maintenance-maintenanc description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-maintenance-maintenanc. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/metric name: cloud-project-servicename-database-m3aggregator-clusterid-metric description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the m3aggregator call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-m3aggregator-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the m3aggregator call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/node name: cloud-project-servicename-database-m3aggregator-clusterid-node description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the m3aggregator call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3aggregator/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-m3aggregator-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-m3aggregator-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get m3aggregator nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db name: cloud-project-servicename-database-m3db description: REST surface for cloud-project-serviceName-database-m3db. operations: - method: GET name: get description: OVH Cloud List all the m3db clusters of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new m3db cluster call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid} name: cloud-project-servicename-database-m3db-clusterid description: REST surface for cloud-project-serviceName-database-m3db-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a m3db cluster call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get m3db cluster properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing m3db cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/advancedconfiguration name: cloud-project-servicename-database-m3db-clusterid-advancedconfiguration description: REST surface for cloud-project-serviceName-database-m3db-clusterId-advancedConfiguration. operations: - method: GET name: get description: OVH Cloud Get m3db advanced configuration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update m3db advanced configuration call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/backup name: cloud-project-servicename-database-m3db-clusterid-backup description: REST surface for cloud-project-serviceName-database-m3db-clusterId-backup. operations: - method: GET name: get description: OVH Cloud List backups of the m3db call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/backup/{backupid} name: cloud-project-servicename-database-m3db-clusterid-backup-backupid description: REST surface for cloud-project-serviceName-database-m3db-clusterId-backup-backupId. operations: - method: GET name: get description: OVH Cloud Get m3db backups call: ovh-cloud-cloud.get with: backupId: rest.backupId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/capabilities/advancedconfiguration name: cloud-project-servicename-database-m3db-clusterid-capabilities-advancedconfigura description: REST surface for cloud-project-serviceName-database-m3db-clusterId-capabilities-advancedConfigura. operations: - method: GET name: get description: OVH Cloud Get m3db advanced configuration fields call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/capabilities/integration name: cloud-project-servicename-database-m3db-clusterid-capabilities-integration description: REST surface for cloud-project-serviceName-database-m3db-clusterId-capabilities-integration. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the m3db service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/integration name: cloud-project-servicename-database-m3db-clusterid-integration description: REST surface for cloud-project-serviceName-database-m3db-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-m3db-clusterid-integration-integrationid description: REST surface for cloud-project-serviceName-database-m3db-clusterId-integration-integrationId. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/iprestriction name: cloud-project-servicename-database-m3db-clusterid-iprestriction description: REST surface for cloud-project-serviceName-database-m3db-clusterId-ipRestriction. operations: - method: GET name: get description: OVH Cloud List m3db ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add ip restrictions to the m3db call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/iprestriction/{ipblock} name: cloud-project-servicename-database-m3db-clusterid-iprestriction-ipblock description: REST surface for cloud-project-serviceName-database-m3db-clusterId-ipRestriction-ipBlock. operations: - method: DELETE name: delete description: OVH Cloud Deletes the given IP from the restricted IPs of the m3db call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get m3db ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Changes the list of ip restrictions to the m3db call: ovh-cloud-cloud.put with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/logs name: cloud-project-servicename-database-m3db-clusterid-logs description: REST surface for cloud-project-serviceName-database-m3db-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent m3db log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/maintenance name: cloud-project-servicename-database-m3db-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-m3db-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the m3db cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-m3db-clusterid-maintenance-maintenanceid description: REST surface for cloud-project-serviceName-database-m3db-clusterId-maintenance-maintenanceId. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the m3db cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-m3db-clusterid-maintenance-maintenanceid-appl description: REST surface for cloud-project-serviceName-database-m3db-clusterId-maintenance-maintenanceId-appl. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/metric name: cloud-project-servicename-database-m3db-clusterid-metric description: REST surface for cloud-project-serviceName-database-m3db-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the m3db cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-m3db-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-m3db-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the m3db cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/namespace name: cloud-project-servicename-database-m3db-clusterid-namespace description: REST surface for cloud-project-serviceName-database-m3db-clusterId-namespace. operations: - method: GET name: get description: OVH Cloud List namespaces of the m3db call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new namespace on the m3db cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/namespace/{namespaceid} name: cloud-project-servicename-database-m3db-clusterid-namespace-namespaceid description: REST surface for cloud-project-serviceName-database-m3db-clusterId-namespace-namespaceId. operations: - method: DELETE name: delete description: OVH Cloud Delete m3db namespace call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId namespaceId: rest.namespaceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get m3db namespaces call: ovh-cloud-cloud.get with: clusterId: rest.clusterId namespaceId: rest.namespaceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Updates the namespace on the m3db cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId namespaceId: rest.namespaceId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/node name: cloud-project-servicename-database-m3db-clusterid-node description: REST surface for cloud-project-serviceName-database-m3db-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the m3db call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-m3db-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-m3db-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get m3db nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/user name: cloud-project-servicename-database-m3db-clusterid-user description: REST surface for cloud-project-serviceName-database-m3db-clusterId-user. operations: - method: GET name: get description: OVH Cloud List users of the m3db call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new user on the m3db cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/user/{userid} name: cloud-project-servicename-database-m3db-clusterid-user-userid description: REST surface for cloud-project-serviceName-database-m3db-clusterId-user-userId. operations: - method: DELETE name: delete description: OVH Cloud Delete m3db user call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get m3db users call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Updates the user on the m3db cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/m3db/{clusterid}/user/{userid}/credentials/reset name: cloud-project-servicename-database-m3db-clusterid-user-userid-credentials-reset description: REST surface for cloud-project-serviceName-database-m3db-clusterId-user-userId-credentials-reset. operations: - method: POST name: post description: OVH Cloud Resets the password of a user call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql name: cloud-project-servicename-database-mysql description: REST surface for cloud-project-serviceName-database-mysql. operations: - method: GET name: get description: OVH Cloud List all the mysql of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new mysql cluster call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid} name: cloud-project-servicename-database-mysql-clusterid description: REST surface for cloud-project-serviceName-database-mysql-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a mysql cluster call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get mysql cluster properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing mysql cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/advancedconfiguration name: cloud-project-servicename-database-mysql-clusterid-advancedconfiguration description: REST surface for cloud-project-serviceName-database-mysql-clusterId-advancedConfiguration. operations: - method: GET name: get description: OVH Cloud Get mysql advanced configuration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update mysql advanced configuration call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/backup name: cloud-project-servicename-database-mysql-clusterid-backup description: REST surface for cloud-project-serviceName-database-mysql-clusterId-backup. operations: - method: GET name: get description: OVH Cloud List backups of the mysql call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/backup/{backupid} name: cloud-project-servicename-database-mysql-clusterid-backup-backupid description: REST surface for cloud-project-serviceName-database-mysql-clusterId-backup-backupId. operations: - method: GET name: get description: OVH Cloud Get mysql backups call: ovh-cloud-cloud.get with: backupId: rest.backupId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/capabilities/advancedconfiguration name: cloud-project-servicename-database-mysql-clusterid-capabilities-advancedconfigur description: REST surface for cloud-project-serviceName-database-mysql-clusterId-capabilities-advancedConfigur. operations: - method: GET name: get description: OVH Cloud Get mysql advanced configuration fields call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/capabilities/integration name: cloud-project-servicename-database-mysql-clusterid-capabilities-integration description: REST surface for cloud-project-serviceName-database-mysql-clusterId-capabilities-integration. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the mysql service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/certificates name: cloud-project-servicename-database-mysql-clusterid-certificates description: REST surface for cloud-project-serviceName-database-mysql-clusterId-certificates. operations: - method: GET name: get description: OVH Cloud Retrieve the certificates of the mysql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/currentqueries name: cloud-project-servicename-database-mysql-clusterid-currentqueries description: REST surface for cloud-project-serviceName-database-mysql-clusterId-currentQueries. operations: - method: GET name: get description: OVH Cloud Retrieve the current queries for the cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId limit: rest.limit offset: rest.offset serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/currentqueries/cancel name: cloud-project-servicename-database-mysql-clusterid-currentqueries-cancel description: REST surface for cloud-project-serviceName-database-mysql-clusterId-currentQueries-cancel. operations: - method: POST name: post description: OVH Cloud Cancel the given current query of the cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/database name: cloud-project-servicename-database-mysql-clusterid-database description: REST surface for cloud-project-serviceName-database-mysql-clusterId-database. operations: - method: GET name: get description: get call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new database on the mysql cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/database/{databaseid} name: cloud-project-servicename-database-mysql-clusterid-database-databaseid description: REST surface for cloud-project-serviceName-database-mysql-clusterId-database-databaseId. operations: - method: DELETE name: delete description: OVH Cloud Delete a mysql database call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId databaseId: rest.databaseId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get the database for the mysql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId databaseId: rest.databaseId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/enablewrites name: cloud-project-servicename-database-mysql-clusterid-enablewrites description: REST surface for cloud-project-serviceName-database-mysql-clusterId-enableWrites. operations: - method: POST name: post description: OVH Cloud Enable temporary write permission on readonly lock mysql service call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/integration name: cloud-project-servicename-database-mysql-clusterid-integration description: REST surface for cloud-project-serviceName-database-mysql-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-mysql-clusterid-integration-integrationid description: REST surface for cloud-project-serviceName-database-mysql-clusterId-integration-integrationId. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/iprestriction name: cloud-project-servicename-database-mysql-clusterid-iprestriction description: REST surface for cloud-project-serviceName-database-mysql-clusterId-ipRestriction. operations: - method: GET name: get description: OVH Cloud List mysql ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add ip restrictions to the mysql call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/iprestriction/{ipblock} name: cloud-project-servicename-database-mysql-clusterid-iprestriction-ipblock description: REST surface for cloud-project-serviceName-database-mysql-clusterId-ipRestriction-ipBlock. operations: - method: DELETE name: delete description: OVH Cloud Deletes the given IP from the restricted IPs of the mysql call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get mysql ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Changes the list of ip restrictions to the mysql call: ovh-cloud-cloud.put with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/logs name: cloud-project-servicename-database-mysql-clusterid-logs description: REST surface for cloud-project-serviceName-database-mysql-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent mysql log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/maintenance name: cloud-project-servicename-database-mysql-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-mysql-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the mysql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-mysql-clusterid-maintenance-maintenanceid description: REST surface for cloud-project-serviceName-database-mysql-clusterId-maintenance-maintenanceId. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the mysql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-mysql-clusterid-maintenance-maintenanceid-app description: REST surface for cloud-project-serviceName-database-mysql-clusterId-maintenance-maintenanceId-app. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/metric name: cloud-project-servicename-database-mysql-clusterid-metric description: REST surface for cloud-project-serviceName-database-mysql-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the mysql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-mysql-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-mysql-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the mysql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/node name: cloud-project-servicename-database-mysql-clusterid-node description: REST surface for cloud-project-serviceName-database-mysql-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the mysql call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-mysql-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-mysql-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get mysql nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/querystatistics name: cloud-project-servicename-database-mysql-clusterid-querystatistics description: REST surface for cloud-project-serviceName-database-mysql-clusterId-queryStatistics. operations: - method: GET name: get description: OVH Cloud Retrieve the query statistics for the cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId limit: rest.limit offset: rest.offset serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/querystatistics/reset name: cloud-project-servicename-database-mysql-clusterid-querystatistics-reset description: REST surface for cloud-project-serviceName-database-mysql-clusterId-queryStatistics-reset. operations: - method: POST name: post description: OVH Cloud Reset the query statistics of the cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/user name: cloud-project-servicename-database-mysql-clusterid-user description: REST surface for cloud-project-serviceName-database-mysql-clusterId-user. operations: - method: GET name: get description: OVH Cloud List users of the mysql call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new user on the mysql cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/user/{userid} name: cloud-project-servicename-database-mysql-clusterid-user-userid description: REST surface for cloud-project-serviceName-database-mysql-clusterId-user-userId. operations: - method: DELETE name: delete description: OVH Cloud Delete a mysql user call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get mysql users call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/mysql/{clusterid}/user/{userid}/credentials/reset name: cloud-project-servicename-database-mysql-clusterid-user-userid-credentials-reset description: REST surface for cloud-project-serviceName-database-mysql-clusterId-user-userId-credentials-reset. operations: - method: POST name: post description: OVH Cloud Resets the password of a user call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch name: cloud-project-servicename-database-opensearch description: REST surface for cloud-project-serviceName-database-opensearch. operations: - method: GET name: get description: OVH Cloud List all the opensearch of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new opensearch cluster call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid} name: cloud-project-servicename-database-opensearch-clusterid description: REST surface for cloud-project-serviceName-database-opensearch-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a opensearch cluster call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get opensearch cluster properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing opensearch cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/advancedconfiguration name: cloud-project-servicename-database-opensearch-clusterid-advancedconfiguration description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-advancedConfiguration. operations: - method: GET name: get description: OVH Cloud Get opensearch advanced configuration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update opensearch advanced configuration call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/backup name: cloud-project-servicename-database-opensearch-clusterid-backup description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-backup. operations: - method: GET name: get description: OVH Cloud List backups of the opensearch call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/backup/{backupid} name: cloud-project-servicename-database-opensearch-clusterid-backup-backupid description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-backup-backupId. operations: - method: GET name: get description: OVH Cloud Get opensearch backups call: ovh-cloud-cloud.get with: backupId: rest.backupId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/capabilities/advancedconfiguration name: cloud-project-servicename-database-opensearch-clusterid-capabilities-advancedcon description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-capabilities-advancedCon. operations: - method: GET name: get description: OVH Cloud Get opensearch advanced configuration fields call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/capabilities/integration name: cloud-project-servicename-database-opensearch-clusterid-capabilities-integration description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-capabilities-integration. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the opensearch service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/index name: cloud-project-servicename-database-opensearch-clusterid-index description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-index. operations: - method: GET name: get description: OVH Cloud List indexes of the opensearch call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/index/{indexid} name: cloud-project-servicename-database-opensearch-clusterid-index-indexid description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-index-indexId. operations: - method: DELETE name: delete description: OVH Cloud Delete an opensearch index call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId indexId: rest.indexId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get opensearch index call: ovh-cloud-cloud.get with: clusterId: rest.clusterId indexId: rest.indexId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/integration name: cloud-project-servicename-database-opensearch-clusterid-integration description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-opensearch-clusterid-integration-integrationi description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-integration-integrationI. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/iprestriction name: cloud-project-servicename-database-opensearch-clusterid-iprestriction description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-ipRestriction. operations: - method: GET name: get description: OVH Cloud List opensearch ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add ip restrictions to the opensearch call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/iprestriction/{ipblock} name: cloud-project-servicename-database-opensearch-clusterid-iprestriction-ipblock description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-ipRestriction-ipBlock. operations: - method: DELETE name: delete description: OVH Cloud Deletes the given IP from the restricted IPs of the opensearch call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get opensearch ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Changes the list of ip restrictions to the opensearch call: ovh-cloud-cloud.put with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/logs name: cloud-project-servicename-database-opensearch-clusterid-logs description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent opensearch log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/maintenance name: cloud-project-servicename-database-opensearch-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the opensearch cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-opensearch-clusterid-maintenance-maintenancei description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-maintenance-maintenanceI. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the opensearch cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-opensearch-clusterid-maintenance-maintenancei description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-maintenance-maintenanceI. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/metric name: cloud-project-servicename-database-opensearch-clusterid-metric description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the opensearch cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-opensearch-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the opensearch cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/node name: cloud-project-servicename-database-opensearch-clusterid-node description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the opensearch call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-opensearch-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get opensearch nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/pattern name: cloud-project-servicename-database-opensearch-clusterid-pattern description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-pattern. operations: - method: GET name: get description: OVH Cloud List patterns of the opensearch call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new pattern on the opensearch cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/pattern/{patternid} name: cloud-project-servicename-database-opensearch-clusterid-pattern-patternid description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-pattern-patternId. operations: - method: DELETE name: delete description: OVH Cloud Delete an opensearch pattern call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId patternId: rest.patternId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get opensearch patterns call: ovh-cloud-cloud.get with: clusterId: rest.clusterId patternId: rest.patternId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/permissions name: cloud-project-servicename-database-opensearch-clusterid-permissions description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-permissions. operations: - method: GET name: get description: OVH Cloud Retrieve the opensearch permissions values call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/user name: cloud-project-servicename-database-opensearch-clusterid-user description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-user. operations: - method: GET name: get description: OVH Cloud List users of the opensearch call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new user on the opensearch cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/user/{userid} name: cloud-project-servicename-database-opensearch-clusterid-user-userid description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-user-userId. operations: - method: DELETE name: delete description: OVH Cloud Delete a opensearch user call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get opensearch users call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update a user on the opensearch cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/opensearch/{clusterid}/user/{userid}/credentials/reset name: cloud-project-servicename-database-opensearch-clusterid-user-userid-credentials description: REST surface for cloud-project-serviceName-database-opensearch-clusterId-user-userId-credentials-. operations: - method: POST name: post description: OVH Cloud Resets the password of a user call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql name: cloud-project-servicename-database-postgresql description: REST surface for cloud-project-serviceName-database-postgresql. operations: - method: GET name: get description: OVH Cloud List all the postgresql of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new postgresql cluster call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid} name: cloud-project-servicename-database-postgresql-clusterid description: REST surface for cloud-project-serviceName-database-postgresql-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a postgresql cluster call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get postgresql cluster properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing postgresql cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/advancedconfiguration name: cloud-project-servicename-database-postgresql-clusterid-advancedconfiguration description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-advancedConfiguration. operations: - method: GET name: get description: OVH Cloud Get postgresql advanced configuration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update postgresql advanced configuration call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/backup name: cloud-project-servicename-database-postgresql-clusterid-backup description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-backup. operations: - method: GET name: get description: OVH Cloud List backups of the postgresql call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/backup/{backupid} name: cloud-project-servicename-database-postgresql-clusterid-backup-backupid description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-backup-backupId. operations: - method: GET name: get description: OVH Cloud Get postgresql backups call: ovh-cloud-cloud.get with: backupId: rest.backupId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/capabilities/advancedconfiguration name: cloud-project-servicename-database-postgresql-clusterid-capabilities-advancedcon description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-capabilities-advancedCon. operations: - method: GET name: get description: OVH Cloud Get postgresql advanced configuration fields call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/capabilities/integration name: cloud-project-servicename-database-postgresql-clusterid-capabilities-integration description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-capabilities-integration. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the postgresql service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/certificates name: cloud-project-servicename-database-postgresql-clusterid-certificates description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-certificates. operations: - method: GET name: get description: OVH Cloud Retrieve the certificates of the postgresql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/connectionpool name: cloud-project-servicename-database-postgresql-clusterid-connectionpool description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-connectionPool. operations: - method: GET name: get description: get call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new connectionPool on the postgresql cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/connectionpool/{connectionpoolid} name: cloud-project-servicename-database-postgresql-clusterid-connectionpool-connectio description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-connectionPool-connectio. operations: - method: DELETE name: delete description: OVH Cloud Delete a postgresql connectionPool call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId connectionPoolId: rest.connectionPoolId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get the connectionPool for the postgresql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId connectionPoolId: rest.connectionPoolId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update a connectionPool on the postgresql cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId connectionPoolId: rest.connectionPoolId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/currentqueries name: cloud-project-servicename-database-postgresql-clusterid-currentqueries description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-currentQueries. operations: - method: GET name: get description: OVH Cloud Retrieve the current queries for the cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId limit: rest.limit offset: rest.offset serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/currentqueries/cancel name: cloud-project-servicename-database-postgresql-clusterid-currentqueries-cancel description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-currentQueries-cancel. operations: - method: POST name: post description: OVH Cloud Cancel the given current query of the cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/database name: cloud-project-servicename-database-postgresql-clusterid-database description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-database. operations: - method: GET name: get description: get call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new database on the postgresql cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/database/{databaseid} name: cloud-project-servicename-database-postgresql-clusterid-database-databaseid description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-database-databaseId. operations: - method: DELETE name: delete description: OVH Cloud Delete a postgresql database call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId databaseId: rest.databaseId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get the database for the postgresql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId databaseId: rest.databaseId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/enablewrites name: cloud-project-servicename-database-postgresql-clusterid-enablewrites description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-enableWrites. operations: - method: POST name: post description: OVH Cloud Enable temporary write permission on readonly lock postgresql service call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/integration name: cloud-project-servicename-database-postgresql-clusterid-integration description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-postgresql-clusterid-integration-integrationi description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-integration-integrationI. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/iprestriction name: cloud-project-servicename-database-postgresql-clusterid-iprestriction description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-ipRestriction. operations: - method: GET name: get description: OVH Cloud List postgresql ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add ip restrictions to the postgresql call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/iprestriction/{ipblock} name: cloud-project-servicename-database-postgresql-clusterid-iprestriction-ipblock description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-ipRestriction-ipBlock. operations: - method: DELETE name: delete description: OVH Cloud Deletes the given IP from the restricted IPs of the postgresql call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get postgresql ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Changes the list of ip restrictions to the postgresql call: ovh-cloud-cloud.put with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/logs name: cloud-project-servicename-database-postgresql-clusterid-logs description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent postgresql log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/maintenance name: cloud-project-servicename-database-postgresql-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the postgresql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-postgresql-clusterid-maintenance-maintenancei description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-maintenance-maintenanceI. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the postgresql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-postgresql-clusterid-maintenance-maintenancei description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-maintenance-maintenanceI. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/metric name: cloud-project-servicename-database-postgresql-clusterid-metric description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the postgresql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-postgresql-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the postgresql cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/node name: cloud-project-servicename-database-postgresql-clusterid-node description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the postgresql call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-postgresql-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get postgresql nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/querystatistics name: cloud-project-servicename-database-postgresql-clusterid-querystatistics description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-queryStatistics. operations: - method: GET name: get description: OVH Cloud Retrieve the query statistics for the cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId limit: rest.limit offset: rest.offset serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/querystatistics/reset name: cloud-project-servicename-database-postgresql-clusterid-querystatistics-reset description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-queryStatistics-reset. operations: - method: POST name: post description: OVH Cloud Reset the query statistics of the cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/roles name: cloud-project-servicename-database-postgresql-clusterid-roles description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-roles. operations: - method: GET name: get description: OVH Cloud Get postgresql roles call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/user name: cloud-project-servicename-database-postgresql-clusterid-user description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-user. operations: - method: GET name: get description: OVH Cloud List users of the postgresql call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new user on the postgresql cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/user/{userid} name: cloud-project-servicename-database-postgresql-clusterid-user-userid description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-user-userId. operations: - method: DELETE name: delete description: OVH Cloud Delete a postgresql user call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get postgresql users call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Updates the user on the postgresql cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/postgresql/{clusterid}/user/{userid}/credentials/reset name: cloud-project-servicename-database-postgresql-clusterid-user-userid-credentials description: REST surface for cloud-project-serviceName-database-postgresql-clusterId-user-userId-credentials-. operations: - method: POST name: post description: OVH Cloud Resets the password of a user call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis name: cloud-project-servicename-database-redis description: REST surface for cloud-project-serviceName-database-redis. operations: - method: GET name: get description: OVH Cloud List all the redis of the project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new redis cluster call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid} name: cloud-project-servicename-database-redis-clusterid description: REST surface for cloud-project-serviceName-database-redis-clusterId. operations: - method: DELETE name: delete description: OVH Cloud Delete a redis cluster call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get redis cluster properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update an existing redis cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/advancedconfiguration name: cloud-project-servicename-database-redis-clusterid-advancedconfiguration description: REST surface for cloud-project-serviceName-database-redis-clusterId-advancedConfiguration. operations: - method: GET name: get description: OVH Cloud Get redis advanced configuration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update redis advanced configuration call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/backup name: cloud-project-servicename-database-redis-clusterid-backup description: REST surface for cloud-project-serviceName-database-redis-clusterId-backup. operations: - method: GET name: get description: OVH Cloud List backups of the redis call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/backup/{backupid} name: cloud-project-servicename-database-redis-clusterid-backup-backupid description: REST surface for cloud-project-serviceName-database-redis-clusterId-backup-backupId. operations: - method: GET name: get description: OVH Cloud Get redis backups call: ovh-cloud-cloud.get with: backupId: rest.backupId clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/capabilities/advancedconfiguration name: cloud-project-servicename-database-redis-clusterid-capabilities-advancedconfigur description: REST surface for cloud-project-serviceName-database-redis-clusterId-capabilities-advancedConfigur. operations: - method: GET name: get description: OVH Cloud Get redis advanced configuration fields call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/capabilities/categories name: cloud-project-servicename-database-redis-clusterid-capabilities-categories description: REST surface for cloud-project-serviceName-database-redis-clusterId-capabilities-categories. operations: - method: GET name: get description: OVH Cloud Get available categories in the redis service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/capabilities/commands name: cloud-project-servicename-database-redis-clusterid-capabilities-commands description: REST surface for cloud-project-serviceName-database-redis-clusterId-capabilities-commands. operations: - method: GET name: get description: OVH Cloud Get available commands in the redis service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/capabilities/integration name: cloud-project-servicename-database-redis-clusterid-capabilities-integration description: REST surface for cloud-project-serviceName-database-redis-clusterId-capabilities-integration. operations: - method: GET name: get description: OVH Cloud Get integration capabilities related to the redis service call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/integration name: cloud-project-servicename-database-redis-clusterid-integration description: REST surface for cloud-project-serviceName-database-redis-clusterId-integration. operations: - method: GET name: get description: OVH Cloud List integrations call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new integration call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/integration/{integrationid} name: cloud-project-servicename-database-redis-clusterid-integration-integrationid description: REST surface for cloud-project-serviceName-database-redis-clusterId-integration-integrationId. operations: - method: DELETE name: delete description: OVH Cloud Delete an integration call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get an integration call: ovh-cloud-cloud.get with: clusterId: rest.clusterId integrationId: rest.integrationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/iprestriction name: cloud-project-servicename-database-redis-clusterid-iprestriction description: REST surface for cloud-project-serviceName-database-redis-clusterId-ipRestriction. operations: - method: GET name: get description: OVH Cloud List redis ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add ip restrictions to the redis call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/iprestriction/{ipblock} name: cloud-project-servicename-database-redis-clusterid-iprestriction-ipblock description: REST surface for cloud-project-serviceName-database-redis-clusterId-ipRestriction-ipBlock. operations: - method: DELETE name: delete description: OVH Cloud Deletes the given IP from the restricted IPs of the redis call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get redis ip restrictions call: ovh-cloud-cloud.get with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Changes the list of ip restrictions to the redis call: ovh-cloud-cloud.put with: clusterId: rest.clusterId ipBlock: rest.ipBlock serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/logs name: cloud-project-servicename-database-redis-clusterid-logs description: REST surface for cloud-project-serviceName-database-redis-clusterId-logs. operations: - method: GET name: get description: OVH Cloud Retrieve the most recent redis log messages (limited to 1000) call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/maintenance name: cloud-project-servicename-database-redis-clusterid-maintenance description: REST surface for cloud-project-serviceName-database-redis-clusterId-maintenance. operations: - method: GET name: get description: OVH Cloud List maintenances for the redis cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/maintenance/{maintenanceid} name: cloud-project-servicename-database-redis-clusterid-maintenance-maintenanceid description: REST surface for cloud-project-serviceName-database-redis-clusterId-maintenance-maintenanceId. operations: - method: GET name: get description: OVH Cloud Get the maintenance for the redis cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/maintenance/{maintenanceid}/apply name: cloud-project-servicename-database-redis-clusterid-maintenance-maintenanceid-app description: REST surface for cloud-project-serviceName-database-redis-clusterId-maintenance-maintenanceId-app. operations: - method: POST name: post description: OVH Cloud Apply the maintenance call: ovh-cloud-cloud.post with: clusterId: rest.clusterId maintenanceId: rest.maintenanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/metric name: cloud-project-servicename-database-redis-clusterid-metric description: REST surface for cloud-project-serviceName-database-redis-clusterId-metric. operations: - method: GET name: get description: OVH Cloud List available metrics for the redis cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId extended: rest.extended serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/metric/{metricname} name: cloud-project-servicename-database-redis-clusterid-metric-metricname description: REST surface for cloud-project-serviceName-database-redis-clusterId-metric-metricName. operations: - method: GET name: get description: OVH Cloud Get the metric values for the redis cluster call: ovh-cloud-cloud.get with: clusterId: rest.clusterId metricName: rest.metricName period: rest.period serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/node name: cloud-project-servicename-database-redis-clusterid-node description: REST surface for cloud-project-serviceName-database-redis-clusterId-node. operations: - method: GET name: get description: OVH Cloud List nodes of the redis call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/node/{nodeid} name: cloud-project-servicename-database-redis-clusterid-node-nodeid description: REST surface for cloud-project-serviceName-database-redis-clusterId-node-nodeId. operations: - method: GET name: get description: OVH Cloud Get redis nodes call: ovh-cloud-cloud.get with: clusterId: rest.clusterId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/user name: cloud-project-servicename-database-redis-clusterid-user description: REST surface for cloud-project-serviceName-database-redis-clusterId-user. operations: - method: GET name: get description: OVH Cloud List users of the redis call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new user on the redis cluster call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/user/{userid} name: cloud-project-servicename-database-redis-clusterid-user-userid description: REST surface for cloud-project-serviceName-database-redis-clusterId-user-userId. operations: - method: DELETE name: delete description: OVH Cloud Delete a redis user call: ovh-cloud-cloud.delete with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get redis users call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update a user on the redis cluster call: ovh-cloud-cloud.put with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/redis/{clusterid}/user/{userid}/credentials/reset name: cloud-project-servicename-database-redis-clusterid-user-userid-credentials-reset description: REST surface for cloud-project-serviceName-database-redis-clusterId-user-userId-credentials-reset. operations: - method: POST name: post description: OVH Cloud Resets the password of a user call: ovh-cloud-cloud.post with: clusterId: rest.clusterId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/service name: cloud-project-servicename-database-service description: REST surface for cloud-project-serviceName-database-service. operations: - method: GET name: get description: OVH Cloud List database services of the project call: ovh-cloud-cloud.get with: category: rest.category serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/database/service/{clusterid} name: cloud-project-servicename-database-service-clusterid description: REST surface for cloud-project-serviceName-database-service-clusterId. operations: - method: GET name: get description: OVH Cloud Get service cluster properties call: ovh-cloud-cloud.get with: clusterId: rest.clusterId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/flavor name: cloud-project-servicename-flavor description: REST surface for cloud-project-serviceName-flavor. operations: - method: GET name: get description: OVH Cloud Get flavors call: ovh-cloud-cloud.get with: region: rest.region serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/flavor/{flavorid} name: cloud-project-servicename-flavor-flavorid description: REST surface for cloud-project-serviceName-flavor-flavorId. operations: - method: GET name: get description: OVH Cloud Get flavor call: ovh-cloud-cloud.get with: flavorId: rest.flavorId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/image name: cloud-project-servicename-image description: REST surface for cloud-project-serviceName-image. operations: - method: GET name: get description: OVH Cloud Get images call: ovh-cloud-cloud.get with: flavorType: rest.flavorType osType: rest.osType region: rest.region serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/image/{imageid} name: cloud-project-servicename-image-imageid description: REST surface for cloud-project-serviceName-image-imageId. operations: - method: GET name: get description: OVH Cloud Get image call: ovh-cloud-cloud.get with: imageId: rest.imageId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance name: cloud-project-servicename-instance description: REST surface for cloud-project-serviceName-instance. operations: - method: GET name: get description: OVH Cloud Get instance call: ovh-cloud-cloud.get with: region: rest.region serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new instance call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/bulk name: cloud-project-servicename-instance-bulk description: REST surface for cloud-project-serviceName-instance-bulk. operations: - method: POST name: post description: OVH Cloud Create multiple instances call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/group name: cloud-project-servicename-instance-group description: REST surface for cloud-project-serviceName-instance-group. operations: - method: GET name: get description: OVH Cloud Get the detail of a group call: ovh-cloud-cloud.get with: region: rest.region serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a group call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/group/{groupid} name: cloud-project-servicename-instance-group-groupid description: REST surface for cloud-project-serviceName-instance-group-groupId. operations: - method: DELETE name: delete description: OVH Cloud Delete a group call: ovh-cloud-cloud.delete with: groupId: rest.groupId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get all groups call: ovh-cloud-cloud.get with: groupId: rest.groupId region: rest.region serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid} name: cloud-project-servicename-instance-instanceid description: REST surface for cloud-project-serviceName-instance-instanceId. operations: - method: DELETE name: delete description: OVH Cloud Delete an instance call: ovh-cloud-cloud.delete with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get instance call: ovh-cloud-cloud.get with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Alter an instance call: ovh-cloud-cloud.put with: instanceId: rest.instanceId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/activemonthlybilling name: cloud-project-servicename-instance-instanceid-activemonthlybilling description: REST surface for cloud-project-serviceName-instance-instanceId-activeMonthlyBilling. operations: - method: POST name: post description: OVH Cloud Activate monthly billing on instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/applicationaccess name: cloud-project-servicename-instance-instanceid-applicationaccess description: REST surface for cloud-project-serviceName-instance-instanceId-applicationAccess. operations: - method: POST name: post description: OVH Cloud Return initial credentials of applications installed from public image call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/interface name: cloud-project-servicename-instance-instanceid-interface description: REST surface for cloud-project-serviceName-instance-instanceId-interface. operations: - method: GET name: get description: OVH Cloud Get interfaces call: ovh-cloud-cloud.get with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create interface on an instance and attached it to a network call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/interface/{interfaceid} name: cloud-project-servicename-instance-instanceid-interface-interfaceid description: REST surface for cloud-project-serviceName-instance-instanceId-interface-interfaceId. operations: - method: DELETE name: delete description: OVH Cloud Delete an interface call: ovh-cloud-cloud.delete with: instanceId: rest.instanceId interfaceId: rest.interfaceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get interface call: ovh-cloud-cloud.get with: instanceId: rest.instanceId interfaceId: rest.interfaceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/monitoring name: cloud-project-servicename-instance-instanceid-monitoring description: REST surface for cloud-project-serviceName-instance-instanceId-monitoring. operations: - method: GET name: get description: OVH Cloud Return many statistics about the virtual machine for a given period call: ovh-cloud-cloud.get with: instanceId: rest.instanceId period: rest.period serviceName: rest.serviceName type: rest.type outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/reboot name: cloud-project-servicename-instance-instanceid-reboot description: REST surface for cloud-project-serviceName-instance-instanceId-reboot. operations: - method: POST name: post description: OVH Cloud Reboot an instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/reinstall name: cloud-project-servicename-instance-instanceid-reinstall description: REST surface for cloud-project-serviceName-instance-instanceId-reinstall. operations: - method: POST name: post description: OVH Cloud Reinstall an instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/rescuemode name: cloud-project-servicename-instance-instanceid-rescuemode description: REST surface for cloud-project-serviceName-instance-instanceId-rescueMode. operations: - method: POST name: post description: OVH Cloud Enable or disable rescue mode call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/resize name: cloud-project-servicename-instance-instanceid-resize description: REST surface for cloud-project-serviceName-instance-instanceId-resize. operations: - method: POST name: post description: OVH Cloud Migrate your instance to another flavor call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/resume name: cloud-project-servicename-instance-instanceid-resume description: REST surface for cloud-project-serviceName-instance-instanceId-resume. operations: - method: POST name: post description: OVH Cloud Resume a suspended instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/shelve name: cloud-project-servicename-instance-instanceid-shelve description: REST surface for cloud-project-serviceName-instance-instanceId-shelve. operations: - method: POST name: post description: OVH Cloud Shelve an instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/snapshot name: cloud-project-servicename-instance-instanceid-snapshot description: REST surface for cloud-project-serviceName-instance-instanceId-snapshot. operations: - method: POST name: post description: OVH Cloud Snapshot an instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/start name: cloud-project-servicename-instance-instanceid-start description: REST surface for cloud-project-serviceName-instance-instanceId-start. operations: - method: POST name: post description: OVH Cloud Start an instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/stop name: cloud-project-servicename-instance-instanceid-stop description: REST surface for cloud-project-serviceName-instance-instanceId-stop. operations: - method: POST name: post description: OVH Cloud Stop an instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/unshelve name: cloud-project-servicename-instance-instanceid-unshelve description: REST surface for cloud-project-serviceName-instance-instanceId-unshelve. operations: - method: POST name: post description: OVH Cloud Unshelve an instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/instance/{instanceid}/vnc name: cloud-project-servicename-instance-instanceid-vnc description: REST surface for cloud-project-serviceName-instance-instanceId-vnc. operations: - method: POST name: post description: OVH Cloud Get VNC access to your instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/ip name: cloud-project-servicename-ip description: REST surface for cloud-project-serviceName-ip. operations: - method: GET name: get description: OVH Cloud Get ips call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/ip/failover name: cloud-project-servicename-ip-failover description: REST surface for cloud-project-serviceName-ip-failover. operations: - method: GET name: get description: OVH Cloud Get failover ips call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/ip/failover/{id} name: cloud-project-servicename-ip-failover-id description: REST surface for cloud-project-serviceName-ip-failover-id. operations: - method: GET name: get description: OVH Cloud Get failover ip call: ovh-cloud-cloud.get with: id: rest.id serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/ip/failover/{id}/attach name: cloud-project-servicename-ip-failover-id-attach description: REST surface for cloud-project-serviceName-ip-failover-id-attach. operations: - method: POST name: post description: OVH Cloud Attach failover ip to an instance call: ovh-cloud-cloud.post with: id: rest.id serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube name: cloud-project-servicename-kube description: REST surface for cloud-project-serviceName-kube. operations: - method: GET name: get description: OVH Cloud List your managed Kubernetes clusters call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new managed Kubernetes cluster call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/regions name: cloud-project-servicename-kube-regions description: REST surface for cloud-project-serviceName-kube-regions. operations: - method: GET name: get description: OVH Cloud List Kubernetes available regions call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid} name: cloud-project-servicename-kube-kubeid description: REST surface for cloud-project-serviceName-kube-kubeId. operations: - method: DELETE name: delete description: OVH Cloud Delete your managed Kubernetes cluster call: ovh-cloud-cloud.delete with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get information about your managed Kubernetes cluster call: ovh-cloud-cloud.get with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update information about your managed Kubernetes cluster call: ovh-cloud-cloud.put with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/auditlogs name: cloud-project-servicename-kube-kubeid-auditlogs description: REST surface for cloud-project-serviceName-kube-kubeId-auditLogs. operations: - method: POST name: post description: OVH Cloud Generate a temporary URL to retrieve audit logs call: ovh-cloud-cloud.post with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/customization name: cloud-project-servicename-kube-kubeid-customization description: REST surface for cloud-project-serviceName-kube-kubeId-customization. operations: - method: GET name: get description: OVH Cloud Get cluster customization call: ovh-cloud-cloud.get with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update cluster customization call: ovh-cloud-cloud.put with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/flavors name: cloud-project-servicename-kube-kubeid-flavors description: REST surface for cloud-project-serviceName-kube-kubeId-flavors. operations: - method: GET name: get description: OVH Cloud List all flavors available call: ovh-cloud-cloud.get with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/iprestrictions name: cloud-project-servicename-kube-kubeid-iprestrictions description: REST surface for cloud-project-serviceName-kube-kubeId-ipRestrictions. operations: - method: GET name: get description: OVH Cloud List your ip restrictions on your cluster call: ovh-cloud-cloud.get with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Append a list of ip restrictions on your cluster call: ovh-cloud-cloud.post with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Remove the current list and add a list of ip restrictions on your cluster call: ovh-cloud-cloud.put with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/iprestrictions/{ip} name: cloud-project-servicename-kube-kubeid-iprestrictions-ip description: REST surface for cloud-project-serviceName-kube-kubeId-ipRestrictions-ip. operations: - method: DELETE name: delete description: OVH Cloud Delete an ip restriction from your cluster call: ovh-cloud-cloud.delete with: ip: rest.ip kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/kubeconfig name: cloud-project-servicename-kube-kubeid-kubeconfig description: REST surface for cloud-project-serviceName-kube-kubeId-kubeconfig. operations: - method: POST name: post description: OVH Cloud Generate kubeconfig file call: ovh-cloud-cloud.post with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/kubeconfig/reset name: cloud-project-servicename-kube-kubeid-kubeconfig-reset description: REST surface for cloud-project-serviceName-kube-kubeId-kubeconfig-reset. operations: - method: POST name: post description: 'OVH Cloud Reset kubeconfig: Certificates will be regenerated, nodes will be reinstalled' call: ovh-cloud-cloud.post with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/log/url name: cloud-project-servicename-kube-kubeid-log-url description: REST surface for cloud-project-serviceName-kube-kubeId-log-url. operations: - method: POST name: post description: OVH Cloud Generate a temporary URL to retrieve logs call: ovh-cloud-cloud.post with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/metrics/etcdusage name: cloud-project-servicename-kube-kubeid-metrics-etcdusage description: REST surface for cloud-project-serviceName-kube-kubeId-metrics-etcdUsage. operations: - method: GET name: get description: OVH Cloud List available metrics for this cluster call: ovh-cloud-cloud.get with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/node name: cloud-project-servicename-kube-kubeid-node description: REST surface for cloud-project-serviceName-kube-kubeId-node. operations: - method: GET name: get description: OVH Cloud List your nodes call: ovh-cloud-cloud.get with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/node/{nodeid} name: cloud-project-servicename-kube-kubeid-node-nodeid description: REST surface for cloud-project-serviceName-kube-kubeId-node-nodeId. operations: - method: DELETE name: delete description: OVH Cloud Delete a specific node on your cluster call: ovh-cloud-cloud.delete with: kubeId: rest.kubeId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get information on a specific node on your cluster call: ovh-cloud-cloud.get with: kubeId: rest.kubeId nodeId: rest.nodeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/nodepool name: cloud-project-servicename-kube-kubeid-nodepool description: REST surface for cloud-project-serviceName-kube-kubeId-nodepool. operations: - method: GET name: get description: OVH Cloud List your nodepools call: ovh-cloud-cloud.get with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a nodepool on your cluster call: ovh-cloud-cloud.post with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/nodepool/{nodepoolid} name: cloud-project-servicename-kube-kubeid-nodepool-nodepoolid description: REST surface for cloud-project-serviceName-kube-kubeId-nodepool-nodePoolId. operations: - method: DELETE name: delete description: OVH Cloud Delete a nodepool from your cluster call: ovh-cloud-cloud.delete with: kubeId: rest.kubeId nodePoolId: rest.nodePoolId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get information on a specific nodepool on your cluster call: ovh-cloud-cloud.get with: kubeId: rest.kubeId nodePoolId: rest.nodePoolId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update your nodepool information call: ovh-cloud-cloud.put with: kubeId: rest.kubeId nodePoolId: rest.nodePoolId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/nodepool/{nodepoolid}/nodes name: cloud-project-servicename-kube-kubeid-nodepool-nodepoolid-nodes description: REST surface for cloud-project-serviceName-kube-kubeId-nodepool-nodePoolId-nodes. operations: - method: GET name: get description: OVH Cloud List all nodes contained in a nodepool call: ovh-cloud-cloud.get with: kubeId: rest.kubeId nodePoolId: rest.nodePoolId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/openidconnect name: cloud-project-servicename-kube-kubeid-openidconnect description: REST surface for cloud-project-serviceName-kube-kubeId-openIdConnect. operations: - method: DELETE name: delete description: OVH Cloud Remove OpenIdConnect integration from APIServer call: ovh-cloud-cloud.delete with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get openIdConnect integration parameters call: ovh-cloud-cloud.get with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Configure APIServer for OpenIdConnect call: ovh-cloud-cloud.post with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update parameters and reconfigure APIServer call: ovh-cloud-cloud.put with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/privatenetworkconfiguration name: cloud-project-servicename-kube-kubeid-privatenetworkconfiguration description: REST surface for cloud-project-serviceName-kube-kubeId-privateNetworkConfiguration. operations: - method: GET name: get description: OVH Cloud Get private network configuration call: ovh-cloud-cloud.get with: kubeId: rest.kubeId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update private network configuration call: ovh-cloud-cloud.put with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/reset name: cloud-project-servicename-kube-kubeid-reset description: REST surface for cloud-project-serviceName-kube-kubeId-reset. operations: - method: POST name: post description: 'OVH Cloud Reset cluster: all Kubernetes data will be erased (pods, services, configuration, etc), nodes will be either deleted or reinstalled' call: ovh-cloud-cloud.post with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/restart name: cloud-project-servicename-kube-kubeid-restart description: REST surface for cloud-project-serviceName-kube-kubeId-restart. operations: - method: POST name: post description: OVH Cloud Restarting your control plane apiserver to invalidate cache without downtime (using force will create a slight downtime) call: ovh-cloud-cloud.post with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/update name: cloud-project-servicename-kube-kubeid-update description: REST surface for cloud-project-serviceName-kube-kubeId-update. operations: - method: POST name: post description: OVH Cloud Force cluster and node update to the latest patch within minor version or next minor version call: ovh-cloud-cloud.post with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/updateloadbalancerssubnetid name: cloud-project-servicename-kube-kubeid-updateloadbalancerssubnetid description: REST surface for cloud-project-serviceName-kube-kubeId-updateLoadBalancersSubnetId. operations: - method: PUT name: put description: OVH Cloud Updates the load balancers subnet ID call: ovh-cloud-cloud.put with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/kube/{kubeid}/updatepolicy name: cloud-project-servicename-kube-kubeid-updatepolicy description: REST surface for cloud-project-serviceName-kube-kubeId-updatePolicy. operations: - method: PUT name: put description: OVH Cloud Change the update policy of your cluster call: ovh-cloud-cloud.put with: kubeId: rest.kubeId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/lab name: cloud-project-servicename-lab description: REST surface for cloud-project-serviceName-lab. operations: - method: GET name: get description: OVH Cloud List available public cloud labs call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/lab/{labid} name: cloud-project-servicename-lab-labid description: REST surface for cloud-project-serviceName-lab-labId. operations: - method: GET name: get description: OVH Cloud Get details of a public cloud lab call: ovh-cloud-cloud.get with: labId: rest.labId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Activate a lab on your Cloud Project call: ovh-cloud-cloud.post with: labId: rest.labId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/lab/{labid}/agreement name: cloud-project-servicename-lab-labid-agreement description: REST surface for cloud-project-serviceName-lab-labId-agreement. operations: - method: GET name: get description: OVH Cloud List required agreements to active this lab call: ovh-cloud-cloud.get with: labId: rest.labId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/loadbalancer name: cloud-project-servicename-loadbalancer description: REST surface for cloud-project-serviceName-loadbalancer. operations: - method: GET name: listloadbalancers description: OVH Cloud List all load balancer for a tenant call: ovh-cloud-cloud.listloadbalancers with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: createloadbalancer description: OVH Cloud Create a load balancer call: ovh-cloud-cloud.createloadbalancer with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/loadbalancer/{loadbalancerid} name: cloud-project-servicename-loadbalancer-loadbalancerid description: REST surface for cloud-project-serviceName-loadbalancer-loadBalancerId. operations: - method: DELETE name: deleteloadbalancer description: OVH Cloud Delete a load balancer call: ovh-cloud-cloud.deleteloadbalancer with: loadBalancerId: rest.loadBalancerId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: getloadbalancer description: OVH Cloud Get a load balancer call: ovh-cloud-cloud.getloadbalancer with: loadBalancerId: rest.loadBalancerId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: updateloadbalancer description: OVH Cloud Update a load balancer call: ovh-cloud-cloud.updateloadbalancer with: loadBalancerId: rest.loadBalancerId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/loadbalancer/{loadbalancerid}/configuration name: cloud-project-servicename-loadbalancer-loadbalancerid-configuration description: REST surface for cloud-project-serviceName-loadbalancer-loadBalancerId-configuration. operations: - method: GET name: listloadbalancerconfigurations description: OVH Cloud List all versions of the configuration call: ovh-cloud-cloud.listloadbalancerconfigurations with: loadBalancerId: rest.loadBalancerId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: createloadbalancerconfiguration description: OVH Cloud Create a configuration call: ovh-cloud-cloud.createloadbalancerconfiguration with: loadBalancerId: rest.loadBalancerId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/loadbalancer/{loadbalancerid}/configuration/{version} name: cloud-project-servicename-loadbalancer-loadbalancerid-configuration-version description: REST surface for cloud-project-serviceName-loadbalancer-loadBalancerId-configuration-version. operations: - method: DELETE name: deleteloadbalancerconfiguration description: OVH Cloud Delete a configuration call: ovh-cloud-cloud.deleteloadbalancerconfiguration with: loadBalancerId: rest.loadBalancerId serviceName: rest.serviceName version: rest.version outputParameters: - type: object mapping: $. - method: GET name: getloadbalancerconfiguration description: OVH Cloud Get a configuration call: ovh-cloud-cloud.getloadbalancerconfiguration with: loadBalancerId: rest.loadBalancerId serviceName: rest.serviceName version: rest.version outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/loadbalancer/{loadbalancerid}/configuration/{version}/apply name: cloud-project-servicename-loadbalancer-loadbalancerid-configuration-version-appl description: REST surface for cloud-project-serviceName-loadbalancer-loadBalancerId-configuration-version-appl. operations: - method: POST name: applyloadbalancerconfiguration description: OVH Cloud Apply a configuration call: ovh-cloud-cloud.applyloadbalancerconfiguration with: loadBalancerId: rest.loadBalancerId serviceName: rest.serviceName version: rest.version outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/network/private name: cloud-project-servicename-network-private description: REST surface for cloud-project-serviceName-network-private. operations: - method: GET name: get description: OVH Cloud Get private networks call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new network call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/network/private/{networkid} name: cloud-project-servicename-network-private-networkid description: REST surface for cloud-project-serviceName-network-private-networkId. operations: - method: DELETE name: delete description: OVH Cloud Delete private network call: ovh-cloud-cloud.delete with: networkId: rest.networkId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get private network call: ovh-cloud-cloud.get with: networkId: rest.networkId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Rename private network call: ovh-cloud-cloud.put with: networkId: rest.networkId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/network/private/{networkid}/region name: cloud-project-servicename-network-private-networkid-region description: REST surface for cloud-project-serviceName-network-private-networkId-region. operations: - method: POST name: post description: OVH Cloud Activate private network in a new region call: ovh-cloud-cloud.post with: networkId: rest.networkId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/network/private/{networkid}/subnet name: cloud-project-servicename-network-private-networkid-subnet description: REST surface for cloud-project-serviceName-network-private-networkId-subnet. operations: - method: GET name: get description: OVH Cloud Get network subnets call: ovh-cloud-cloud.get with: networkId: rest.networkId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new network subnet call: ovh-cloud-cloud.post with: networkId: rest.networkId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/network/private/{networkid}/subnet/{subnetid} name: cloud-project-servicename-network-private-networkid-subnet-subnetid description: REST surface for cloud-project-serviceName-network-private-networkId-subnet-subnetId. operations: - method: DELETE name: delete description: OVH Cloud Delete a network subnet call: ovh-cloud-cloud.delete with: networkId: rest.networkId serviceName: rest.serviceName subnetId: rest.subnetId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/network/public name: cloud-project-servicename-network-public description: REST surface for cloud-project-serviceName-network-public. operations: - method: GET name: get description: OVH Cloud Get public networks call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/operation name: cloud-project-servicename-operation description: REST surface for cloud-project-serviceName-operation. operations: - method: GET name: get description: OVH Cloud List your operations call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/operation/{operationid} name: cloud-project-servicename-operation-operationid description: REST surface for cloud-project-serviceName-operation-operationId. operations: - method: GET name: get description: OVH Cloud Get information about one operation call: ovh-cloud-cloud.get with: operationId: rest.operationId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/quota name: cloud-project-servicename-quota description: REST surface for cloud-project-serviceName-quota. operations: - method: GET name: get description: OVH Cloud List quotas call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region name: cloud-project-servicename-region description: REST surface for cloud-project-serviceName-region. operations: - method: GET name: get description: OVH Cloud List your regions call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Request access to a region call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname} name: cloud-project-servicename-region-regionname description: REST surface for cloud-project-serviceName-region-regionName. operations: - method: GET name: get description: OVH Cloud Get information about your region call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/floatingip name: cloud-project-servicename-region-regionname-floatingip description: REST surface for cloud-project-serviceName-region-regionName-floatingip. operations: - method: GET name: get description: OVH Cloud Get floating ips call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/floatingip/{floatingipid} name: cloud-project-servicename-region-regionname-floatingip-floatingipid description: REST surface for cloud-project-serviceName-region-regionName-floatingip-floatingIpId. operations: - method: DELETE name: delete description: OVH Cloud Delete a floating ip call: ovh-cloud-cloud.delete with: floatingIpId: rest.floatingIpId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get a floating ip call: ovh-cloud-cloud.get with: floatingIpId: rest.floatingIpId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/floatingip/{floatingipid}/detach name: cloud-project-servicename-region-regionname-floatingip-floatingipid-detach description: REST surface for cloud-project-serviceName-region-regionName-floatingip-floatingIpId-detach. operations: - method: POST name: post description: OVH Cloud Detach your floating ip call: ovh-cloud-cloud.post with: floatingIpId: rest.floatingIpId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/gateway name: cloud-project-servicename-region-regionname-gateway description: REST surface for cloud-project-serviceName-region-regionName-gateway. operations: - method: GET name: get description: OVH Cloud List gateways call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName subnetId: rest.subnetId outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create new Gateway and new Private Network with new Subnet call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/gateway/{id} name: cloud-project-servicename-region-regionname-gateway-id description: REST surface for cloud-project-serviceName-region-regionName-gateway-id. operations: - method: DELETE name: delete description: OVH Cloud Delete gateway call: ovh-cloud-cloud.delete with: id: rest.id regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get gateway call: ovh-cloud-cloud.get with: id: rest.id regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update a gateway call: ovh-cloud-cloud.put with: id: rest.id regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/gateway/{id}/expose name: cloud-project-servicename-region-regionname-gateway-id-expose description: REST surface for cloud-project-serviceName-region-regionName-gateway-id-expose. operations: - method: POST name: post description: OVH Cloud Expose gateway to public network by adding a public port on it. call: ovh-cloud-cloud.post with: id: rest.id regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/gateway/{id}/interface name: cloud-project-servicename-region-regionname-gateway-id-interface description: REST surface for cloud-project-serviceName-region-regionName-gateway-id-interface. operations: - method: GET name: get description: OVH Cloud List interfaces call: ovh-cloud-cloud.get with: id: rest.id regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create gateway interface call: ovh-cloud-cloud.post with: id: rest.id regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/gateway/{id}/interface/{interfaceid} name: cloud-project-servicename-region-regionname-gateway-id-interface-interfaceid description: REST surface for cloud-project-serviceName-region-regionName-gateway-id-interface-interfaceId. operations: - method: DELETE name: delete description: OVH Cloud Delete gateway interface call: ovh-cloud-cloud.delete with: id: rest.id interfaceId: rest.interfaceId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get interface call: ovh-cloud-cloud.get with: id: rest.id interfaceId: rest.interfaceId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/instance/{instanceid}/abortsnapshot name: cloud-project-servicename-region-regionname-instance-instanceid-abortsnapshot description: REST surface for cloud-project-serviceName-region-regionName-instance-instanceId-abortSnapshot. operations: - method: POST name: post description: OVH Cloud Abort an instance snapshot creation call: ovh-cloud-cloud.post with: instanceId: rest.instanceId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/instance/{instanceid}/associatefloatingip name: cloud-project-servicename-region-regionname-instance-instanceid-associatefloatin description: REST surface for cloud-project-serviceName-region-regionName-instance-instanceId-associateFloatin. operations: - method: POST name: post description: OVH Cloud Associate an existing floating IP to an instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/instance/{instanceid}/floatingip name: cloud-project-servicename-region-regionname-instance-instanceid-floatingip description: REST surface for cloud-project-serviceName-region-regionName-instance-instanceId-floatingIp. operations: - method: POST name: post description: OVH Cloud Create a floating IP and attach it to an instance call: ovh-cloud-cloud.post with: instanceId: rest.instanceId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/keymanager/certificate name: cloud-project-servicename-region-regionname-keymanager-certificate description: REST surface for cloud-project-serviceName-region-regionName-keymanager-certificate. operations: - method: GET name: get description: OVH Cloud List certificates call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new certificate call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/keymanager/certificate/{certificateid} name: cloud-project-servicename-region-regionname-keymanager-certificate-certificateid description: REST surface for cloud-project-serviceName-region-regionName-keymanager-certificate-certificateId. operations: - method: DELETE name: delete description: OVH Cloud Delete a certificate call: ovh-cloud-cloud.delete with: certificateId: rest.certificateId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get details about a certificate call: ovh-cloud-cloud.get with: certificateId: rest.certificateId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/keymanager/secret name: cloud-project-servicename-region-regionname-keymanager-secret description: REST surface for cloud-project-serviceName-region-regionName-keymanager-secret. operations: - method: GET name: get description: OVH Cloud List secrets call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/keymanager/secret/{secretid} name: cloud-project-servicename-region-regionname-keymanager-secret-secretid description: REST surface for cloud-project-serviceName-region-regionName-keymanager-secret-secretId. operations: - method: DELETE name: delete description: OVH Cloud Delete a secret call: ovh-cloud-cloud.delete with: regionName: rest.regionName secretId: rest.secretId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get details about a secret call: ovh-cloud-cloud.get with: regionName: rest.regionName secretId: rest.secretId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/flavor name: cloud-project-servicename-region-regionname-loadbalancing-flavor description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-flavor. operations: - method: GET name: get description: OVH Cloud List flavors call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/flavor/{flavorid} name: cloud-project-servicename-region-regionname-loadbalancing-flavor-flavorid description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-flavor-flavorId. operations: - method: GET name: get description: OVH Cloud Get details about a load balancing flavor call: ovh-cloud-cloud.get with: flavorId: rest.flavorId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/healthmonitor name: cloud-project-servicename-region-regionname-loadbalancing-healthmonitor description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-healthMonitor. operations: - method: GET name: get description: OVH Cloud List health monitors call: ovh-cloud-cloud.get with: poolId: rest.poolId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create health monitor call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/healthmonitor/{healthmonitorid} name: cloud-project-servicename-region-regionname-loadbalancing-healthmonitor-healthmo description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-healthMonitor-healthMo. operations: - method: DELETE name: delete description: OVH Cloud Delete health monitor call: ovh-cloud-cloud.delete with: healthMonitorId: rest.healthMonitorId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get details about a loadbalancer health monitor call: ovh-cloud-cloud.get with: healthMonitorId: rest.healthMonitorId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update a health monitor call: ovh-cloud-cloud.put with: healthMonitorId: rest.healthMonitorId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/l7policy name: cloud-project-servicename-region-regionname-loadbalancing-l7policy description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-l7Policy. operations: - method: GET name: get description: get call: ovh-cloud-cloud.get with: listenerId: rest.listenerId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: post call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/l7policy/{l7policyid} name: cloud-project-servicename-region-regionname-loadbalancing-l7policy-l7policyid description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-l7Policy-l7PolicyId. operations: - method: DELETE name: delete description: delete call: ovh-cloud-cloud.delete with: l7PolicyId: rest.l7PolicyId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: get call: ovh-cloud-cloud.get with: l7PolicyId: rest.l7PolicyId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: put call: ovh-cloud-cloud.put with: l7PolicyId: rest.l7PolicyId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/l7policy/{l7policyid}/l7rule name: cloud-project-servicename-region-regionname-loadbalancing-l7policy-l7policyid-l7 description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-l7Policy-l7PolicyId-l7. operations: - method: GET name: get description: get call: ovh-cloud-cloud.get with: l7PolicyId: rest.l7PolicyId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: post call: ovh-cloud-cloud.post with: l7PolicyId: rest.l7PolicyId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/l7policy/{l7policyid}/l7rule/{l7ruleid} name: cloud-project-servicename-region-regionname-loadbalancing-l7policy-l7policyid-l7 description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-l7Policy-l7PolicyId-l7. operations: - method: DELETE name: delete description: delete call: ovh-cloud-cloud.delete with: l7PolicyId: rest.l7PolicyId l7RuleId: rest.l7RuleId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: get call: ovh-cloud-cloud.get with: l7PolicyId: rest.l7PolicyId l7RuleId: rest.l7RuleId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: put call: ovh-cloud-cloud.put with: l7PolicyId: rest.l7PolicyId l7RuleId: rest.l7RuleId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/listener name: cloud-project-servicename-region-regionname-loadbalancing-listener description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-listener. operations: - method: GET name: get description: OVH Cloud List your loadbalancer listeners call: ovh-cloud-cloud.get with: loadbalancerId: rest.loadbalancerId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a loadbalancer listener call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/listener/{listenerid} name: cloud-project-servicename-region-regionname-loadbalancing-listener-listenerid description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-listener-listenerId. operations: - method: DELETE name: delete description: OVH Cloud Delete loadbalancer listener call: ovh-cloud-cloud.delete with: listenerId: rest.listenerId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get details about a loadbalancer listener call: ovh-cloud-cloud.get with: listenerId: rest.listenerId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Edit a loadbalancer listener call: ovh-cloud-cloud.put with: listenerId: rest.listenerId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/loadbalancer name: cloud-project-servicename-region-regionname-loadbalancing-loadbalancer description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-loadbalancer. operations: - method: GET name: get description: OVH Cloud List your load balancers call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a loadbalancer call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/loadbalancer/{loadbalancerid} name: cloud-project-servicename-region-regionname-loadbalancing-loadbalancer-loadbalan description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-loadbalancer-loadBalan. operations: - method: DELETE name: delete description: OVH Cloud Delete loadbalancer call: ovh-cloud-cloud.delete with: loadBalancerId: rest.loadBalancerId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get details about a load balancer call: ovh-cloud-cloud.get with: loadBalancerId: rest.loadBalancerId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Edit a loadbalancer call: ovh-cloud-cloud.put with: loadBalancerId: rest.loadBalancerId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/loadbalancer/{loadbalancerid}/associatefloatingip name: cloud-project-servicename-region-regionname-loadbalancing-loadbalancer-loadbalan description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-loadbalancer-loadBalan. operations: - method: POST name: post description: OVH Cloud Associate an existing floating IP to a loadbalancer call: ovh-cloud-cloud.post with: loadBalancerId: rest.loadBalancerId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/loadbalancer/{loadbalancerid}/floatingip name: cloud-project-servicename-region-regionname-loadbalancing-loadbalancer-loadbalan description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-loadbalancer-loadBalan. operations: - method: POST name: post description: OVH Cloud Create a floating IP and attach it to a loadbalancer call: ovh-cloud-cloud.post with: loadBalancerId: rest.loadBalancerId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/loadbalancer/{loadbalancerid}/stats name: cloud-project-servicename-region-regionname-loadbalancing-loadbalancer-loadbalan description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-loadbalancer-loadBalan. operations: - method: GET name: get description: OVH Cloud Get loadbalancer statistics call: ovh-cloud-cloud.get with: loadBalancerId: rest.loadBalancerId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/pool name: cloud-project-servicename-region-regionname-loadbalancing-pool description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-pool. operations: - method: GET name: get description: OVH Cloud List your loadbalancer pools call: ovh-cloud-cloud.get with: loadbalancerId: rest.loadbalancerId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a loadbalancer pool call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/pool/{poolid} name: cloud-project-servicename-region-regionname-loadbalancing-pool-poolid description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-pool-poolId. operations: - method: DELETE name: delete description: OVH Cloud Delete a loadbalancer pool call: ovh-cloud-cloud.delete with: poolId: rest.poolId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get details about a loadbalancer pool call: ovh-cloud-cloud.get with: poolId: rest.poolId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update a loadbalancer pool call: ovh-cloud-cloud.put with: poolId: rest.poolId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/pool/{poolid}/member name: cloud-project-servicename-region-regionname-loadbalancing-pool-poolid-member description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-pool-poolId-member. operations: - method: GET name: get description: OVH Cloud List your pool members call: ovh-cloud-cloud.get with: poolId: rest.poolId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create pool members call: ovh-cloud-cloud.post with: poolId: rest.poolId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/loadbalancing/pool/{poolid}/member/{memberid} name: cloud-project-servicename-region-regionname-loadbalancing-pool-poolid-member-mem description: REST surface for cloud-project-serviceName-region-regionName-loadbalancing-pool-poolId-member-mem. operations: - method: DELETE name: delete description: OVH Cloud Delete a pool member call: ovh-cloud-cloud.delete with: memberId: rest.memberId poolId: rest.poolId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get details about a pool member call: ovh-cloud-cloud.get with: memberId: rest.memberId poolId: rest.poolId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update a pool member call: ovh-cloud-cloud.put with: memberId: rest.memberId poolId: rest.poolId regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/network name: cloud-project-servicename-region-regionname-network description: REST surface for cloud-project-serviceName-region-regionName-network. operations: - method: GET name: get description: OVH Cloud List networks call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a network with a gateway call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/network/{networkid} name: cloud-project-servicename-region-regionname-network-networkid description: REST surface for cloud-project-serviceName-region-regionName-network-networkId. operations: - method: DELETE name: delete description: OVH Cloud Delete network call: ovh-cloud-cloud.delete with: networkId: rest.networkId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get network call: ovh-cloud-cloud.get with: networkId: rest.networkId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/network/{networkid}/subnet name: cloud-project-servicename-region-regionname-network-networkid-subnet description: REST surface for cloud-project-serviceName-region-regionName-network-networkId-subnet. operations: - method: GET name: get description: OVH Cloud List subnets call: ovh-cloud-cloud.get with: networkId: rest.networkId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/network/{networkid}/subnet/{subnetid} name: cloud-project-servicename-region-regionname-network-networkid-subnet-subnetid description: REST surface for cloud-project-serviceName-region-regionName-network-networkId-subnet-subnetId. operations: - method: DELETE name: delete description: OVH Cloud Delete subnet call: ovh-cloud-cloud.delete with: networkId: rest.networkId regionName: rest.regionName serviceName: rest.serviceName subnetId: rest.subnetId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get subnet call: ovh-cloud-cloud.get with: networkId: rest.networkId regionName: rest.regionName serviceName: rest.serviceName subnetId: rest.subnetId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/network/{networkid}/subnet/{subnetid}/gateway name: cloud-project-servicename-region-regionname-network-networkid-subnet-subnetid-ga description: REST surface for cloud-project-serviceName-region-regionName-network-networkId-subnet-subnetId-ga. operations: - method: POST name: post description: OVH Cloud Create Gateway for existing subnet call: ovh-cloud-cloud.post with: networkId: rest.networkId regionName: rest.regionName serviceName: rest.serviceName subnetId: rest.subnetId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/quota name: cloud-project-servicename-region-regionname-quota description: REST surface for cloud-project-serviceName-region-regionName-quota. operations: - method: GET name: get description: OVH Cloud List quotas call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Change project quotas on region call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/quota/allowed name: cloud-project-servicename-region-regionname-quota-allowed description: REST surface for cloud-project-serviceName-region-regionName-quota-allowed. operations: - method: GET name: get description: OVH Cloud Get allowed quotas on region call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/quota/storage name: cloud-project-servicename-region-regionname-quota-storage description: REST surface for cloud-project-serviceName-region-regionName-quota-storage. operations: - method: DELETE name: delete description: OVH Cloud Delete storage quota on region call: ovh-cloud-cloud.delete with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get storage quotas on region call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update storage quota on region call: ovh-cloud-cloud.put with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/storage name: cloud-project-servicename-region-regionname-storage description: REST surface for cloud-project-serviceName-region-regionName-storage. operations: - method: GET name: get description: OVH Cloud Get S3 storage containers call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create S3 storage container call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/storage/{name} name: cloud-project-servicename-region-regionname-storage-name description: REST surface for cloud-project-serviceName-region-regionName-storage-name. operations: - method: DELETE name: delete description: OVH Cloud Delete S3 storage container call: ovh-cloud-cloud.delete with: name: rest.name regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get S3 storage container call: ovh-cloud-cloud.get with: limit: rest.limit marker: rest.marker name: rest.name prefix: rest.prefix regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update S3 storage container call: ovh-cloud-cloud.put with: name: rest.name regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/storage/{name}/object/{objectkey} name: cloud-project-servicename-region-regionname-storage-name-object-objectkey description: REST surface for cloud-project-serviceName-region-regionName-storage-name-object-objectKey. operations: - method: DELETE name: delete description: OVH Cloud Delete S3 storage container object call: ovh-cloud-cloud.delete with: name: rest.name objectKey: rest.objectKey regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/storage/{name}/policy/{userid} name: cloud-project-servicename-region-regionname-storage-name-policy-userid description: REST surface for cloud-project-serviceName-region-regionName-storage-name-policy-userId. operations: - method: POST name: post description: OVH Cloud Add S3 storage container policy call: ovh-cloud-cloud.post with: name: rest.name regionName: rest.regionName serviceName: rest.serviceName userId: rest.userId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/storage/{name}/presign name: cloud-project-servicename-region-regionname-storage-name-presign description: REST surface for cloud-project-serviceName-region-regionName-storage-name-presign. operations: - method: POST name: post description: OVH Cloud Generate S3 presigned URLs to download or upload objects call: ovh-cloud-cloud.post with: name: rest.name regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/volumebackup name: cloud-project-servicename-region-regionname-volumebackup description: REST surface for cloud-project-serviceName-region-regionName-volumeBackup. operations: - method: GET name: get description: OVH Cloud List volume backups call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a volume backup call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/volumebackup/{volumebackupid} name: cloud-project-servicename-region-regionname-volumebackup-volumebackupid description: REST surface for cloud-project-serviceName-region-regionName-volumeBackup-volumeBackupId. operations: - method: DELETE name: delete description: OVH Cloud Delete volume backup call: ovh-cloud-cloud.delete with: regionName: rest.regionName serviceName: rest.serviceName volumeBackupId: rest.volumeBackupId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get volume backup call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName volumeBackupId: rest.volumeBackupId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/volumebackup/{volumebackupid}/restore name: cloud-project-servicename-region-regionname-volumebackup-volumebackupid-restore description: REST surface for cloud-project-serviceName-region-regionName-volumeBackup-volumeBackupId-restore. operations: - method: POST name: post description: OVH Cloud Restore a volume backup on a volume call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName volumeBackupId: rest.volumeBackupId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/volumebackup/{volumebackupid}/volume name: cloud-project-servicename-region-regionname-volumebackup-volumebackupid-volume description: REST surface for cloud-project-serviceName-region-regionName-volumeBackup-volumeBackupId-volume. operations: - method: POST name: post description: OVH Cloud Create a volume from a volume backup call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName volumeBackupId: rest.volumeBackupId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/workflow/backup name: cloud-project-servicename-region-regionname-workflow-backup description: REST surface for cloud-project-serviceName-region-regionName-workflow-backup. operations: - method: GET name: get description: OVH Cloud List your automated backups call: ovh-cloud-cloud.get with: regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new automated backup call: ovh-cloud-cloud.post with: regionName: rest.regionName serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/region/{regionname}/workflow/backup/{backupworkflowid} name: cloud-project-servicename-region-regionname-workflow-backup-backupworkflowid description: REST surface for cloud-project-serviceName-region-regionName-workflow-backup-backupWorkflowId. operations: - method: DELETE name: delete description: OVH Cloud Delete a backup workflow process call: ovh-cloud-cloud.delete with: backupWorkflowId: rest.backupWorkflowId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get details about a backup workflow process call: ovh-cloud-cloud.get with: backupWorkflowId: rest.backupWorkflowId regionName: rest.regionName serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/regionavailable name: cloud-project-servicename-regionavailable description: REST surface for cloud-project-serviceName-regionAvailable. operations: - method: GET name: get description: OVH Cloud List the regions on which you can ask an access to call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/role name: cloud-project-servicename-role description: REST surface for cloud-project-serviceName-role. operations: - method: GET name: get description: OVH Cloud Get all Roles call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/serviceinfos name: cloud-project-servicename-serviceinfos description: REST surface for cloud-project-serviceName-serviceInfos. operations: - method: GET name: get description: OVH Cloud Get service information call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update service information call: ovh-cloud-cloud.put with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/snapshot name: cloud-project-servicename-snapshot description: REST surface for cloud-project-serviceName-snapshot. operations: - method: GET name: get description: OVH Cloud Get snapshots call: ovh-cloud-cloud.get with: flavorType: rest.flavorType region: rest.region serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/snapshot/{imageid} name: cloud-project-servicename-snapshot-imageid description: REST surface for cloud-project-serviceName-snapshot-imageId. operations: - method: DELETE name: delete description: OVH Cloud Delete a snapshot call: ovh-cloud-cloud.delete with: imageId: rest.imageId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get snapshot details call: ovh-cloud-cloud.get with: imageId: rest.imageId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/sshkey name: cloud-project-servicename-sshkey description: REST surface for cloud-project-serviceName-sshkey. operations: - method: GET name: get description: OVH Cloud Get SSH keys call: ovh-cloud-cloud.get with: region: rest.region serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create SSH key call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/sshkey/{keyid} name: cloud-project-servicename-sshkey-keyid description: REST surface for cloud-project-serviceName-sshkey-keyId. operations: - method: DELETE name: delete description: OVH Cloud Delete SSH key call: ovh-cloud-cloud.delete with: keyId: rest.keyId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get SSH key call: ovh-cloud-cloud.get with: keyId: rest.keyId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/stack name: cloud-project-servicename-stack description: REST surface for cloud-project-serviceName-stack. operations: - method: GET name: get description: OVH Cloud Get stacks call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/stack/{stackid} name: cloud-project-servicename-stack-stackid description: REST surface for cloud-project-serviceName-stack-stackId. operations: - method: GET name: get description: OVH Cloud Get stack call: ovh-cloud-cloud.get with: serviceName: rest.serviceName stackId: rest.stackId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/storage name: cloud-project-servicename-storage description: REST surface for cloud-project-serviceName-storage. operations: - method: GET name: get description: OVH Cloud Get SWIFT storage containers call: ovh-cloud-cloud.get with: includeType: rest.includeType serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create SWIFT container call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/storage/access name: cloud-project-servicename-storage-access description: REST surface for cloud-project-serviceName-storage-access. operations: - method: POST name: post description: OVH Cloud Access to SWIFT storage API call: ovh-cloud-cloud.post with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/storage/quota name: cloud-project-servicename-storage-quota description: REST surface for cloud-project-serviceName-storage-quota. operations: - method: GET name: get description: OVH Cloud List storage quotas call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/storage/{containerid} name: cloud-project-servicename-storage-containerid description: REST surface for cloud-project-serviceName-storage-containerId. operations: - method: DELETE name: delete description: OVH Cloud Delete SWIFT container call: ovh-cloud-cloud.delete with: containerId: rest.containerId recursive: rest.recursive serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get SWIFT storage container call: ovh-cloud-cloud.get with: containerId: rest.containerId noObjects: rest.noObjects prefix: rest.prefix serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update SWIFT storage container call: ovh-cloud-cloud.put with: containerId: rest.containerId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/storage/{containerid}/cors name: cloud-project-servicename-storage-containerid-cors description: REST surface for cloud-project-serviceName-storage-containerId-cors. operations: - method: DELETE name: delete description: OVH Cloud Delete CORS support on SWIFT container call: ovh-cloud-cloud.delete with: containerId: rest.containerId origin: rest.origin serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add CORS support on SWIFT container call: ovh-cloud-cloud.post with: containerId: rest.containerId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/storage/{containerid}/publicurl name: cloud-project-servicename-storage-containerid-publicurl description: REST surface for cloud-project-serviceName-storage-containerId-publicUrl. operations: - method: POST name: post description: OVH Cloud Get a public temporary URL to access one of your SWIFT object call: ovh-cloud-cloud.post with: containerId: rest.containerId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/storage/{containerid}/static name: cloud-project-servicename-storage-containerid-static description: REST surface for cloud-project-serviceName-storage-containerId-static. operations: - method: POST name: post description: OVH Cloud Deploy your SWIFT container files as a static web site call: ovh-cloud-cloud.post with: containerId: rest.containerId serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/storage/{containerid}/user name: cloud-project-servicename-storage-containerid-user description: REST surface for cloud-project-serviceName-storage-containerId-user. operations: - method: POST name: post description: OVH Cloud Create openstack user with only access to this SWIFT container call: ovh-cloud-cloud.post with: containerId: rest.containerId serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/terminate name: cloud-project-servicename-terminate description: REST surface for cloud-project-serviceName-terminate. operations: - method: POST name: post description: OVH Cloud Ask for the termination of your service call: ovh-cloud-cloud.post with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user name: cloud-project-servicename-user description: REST surface for cloud-project-serviceName-user. operations: - method: GET name: get description: OVH Cloud Get all users call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create user call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid} name: cloud-project-servicename-user-userid description: REST surface for cloud-project-serviceName-user-userId. operations: - method: DELETE name: delete description: OVH Cloud Delete user call: ovh-cloud-cloud.delete with: serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get user details call: ovh-cloud-cloud.get with: serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/configuration name: cloud-project-servicename-user-userid-configuration description: REST surface for cloud-project-serviceName-user-userId-configuration. operations: - method: GET name: get description: OVH Cloud Get your client configuration call: ovh-cloud-cloud.get with: region: rest.region serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/openrc name: cloud-project-servicename-user-userid-openrc description: REST surface for cloud-project-serviceName-user-userId-openrc. operations: - method: GET name: get description: OVH Cloud Get RC file of OpenStack call: ovh-cloud-cloud.get with: region: rest.region serviceName: rest.serviceName userId: rest.userId version: rest.version outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/policy name: cloud-project-servicename-user-userid-policy description: REST surface for cloud-project-serviceName-user-userId-policy. operations: - method: GET name: get description: OVH Cloud Export user storage policy call: ovh-cloud-cloud.get with: serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Import user storage policy call: ovh-cloud-cloud.post with: serviceName: rest.serviceName userId: rest.userId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/rclone name: cloud-project-servicename-user-userid-rclone description: REST surface for cloud-project-serviceName-user-userId-rclone. operations: - method: GET name: get description: OVH Cloud Get rclone configuration file call: ovh-cloud-cloud.get with: region: rest.region service: rest.service serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/regeneratepassword name: cloud-project-servicename-user-userid-regeneratepassword description: REST surface for cloud-project-serviceName-user-userId-regeneratePassword. operations: - method: POST name: post description: OVH Cloud Regenerate user password call: ovh-cloud-cloud.post with: serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/role name: cloud-project-servicename-user-userid-role description: REST surface for cloud-project-serviceName-user-userId-role. operations: - method: GET name: get description: OVH Cloud Get user roles call: ovh-cloud-cloud.get with: serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Add a role to a user call: ovh-cloud-cloud.post with: serviceName: rest.serviceName userId: rest.userId body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update roles of a user call: ovh-cloud-cloud.put with: serviceName: rest.serviceName userId: rest.userId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/role/{roleid} name: cloud-project-servicename-user-userid-role-roleid description: REST surface for cloud-project-serviceName-user-userId-role-roleId. operations: - method: DELETE name: delete description: OVH Cloud Remove role for a user call: ovh-cloud-cloud.delete with: roleId: rest.roleId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get role detail call: ovh-cloud-cloud.get with: roleId: rest.roleId serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/s3credentials name: cloud-project-servicename-user-userid-s3credentials description: REST surface for cloud-project-serviceName-user-userId-s3Credentials. operations: - method: GET name: get description: OVH Cloud List your S3 credentials call: ovh-cloud-cloud.get with: serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a new S3 credentials for an user call: ovh-cloud-cloud.post with: serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/s3credentials/{access} name: cloud-project-servicename-user-userid-s3credentials-access description: REST surface for cloud-project-serviceName-user-userId-s3Credentials-access. operations: - method: DELETE name: delete description: OVH Cloud Delete an S3 credential call: ovh-cloud-cloud.delete with: access: rest.access serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get details about an S3 credential call: ovh-cloud-cloud.get with: access: rest.access serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/s3credentials/{access}/secret name: cloud-project-servicename-user-userid-s3credentials-access-secret description: REST surface for cloud-project-serviceName-user-userId-s3Credentials-access-secret. operations: - method: POST name: post description: OVH Cloud Display secret from a S3 credential call: ovh-cloud-cloud.post with: access: rest.access serviceName: rest.serviceName userId: rest.userId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/user/{userid}/token name: cloud-project-servicename-user-userid-token description: REST surface for cloud-project-serviceName-user-userId-token. operations: - method: POST name: post description: OVH Cloud Get token for user call: ovh-cloud-cloud.post with: serviceName: rest.serviceName userId: rest.userId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/volume name: cloud-project-servicename-volume description: REST surface for cloud-project-serviceName-volume. operations: - method: GET name: get description: OVH Cloud Get volumes call: ovh-cloud-cloud.get with: region: rest.region serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Create a volume call: ovh-cloud-cloud.post with: serviceName: rest.serviceName body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/volume/snapshot name: cloud-project-servicename-volume-snapshot description: REST surface for cloud-project-serviceName-volume-snapshot. operations: - method: GET name: get description: OVH Cloud Get volume snapshots call: ovh-cloud-cloud.get with: region: rest.region serviceName: rest.serviceName outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/volume/snapshot/{snapshotid} name: cloud-project-servicename-volume-snapshot-snapshotid description: REST surface for cloud-project-serviceName-volume-snapshot-snapshotId. operations: - method: DELETE name: delete description: OVH Cloud Delete a volume snapshot call: ovh-cloud-cloud.delete with: serviceName: rest.serviceName snapshotId: rest.snapshotId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get volume snapshot details call: ovh-cloud-cloud.get with: serviceName: rest.serviceName snapshotId: rest.snapshotId outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/volume/{volumeid} name: cloud-project-servicename-volume-volumeid description: REST surface for cloud-project-serviceName-volume-volumeId. operations: - method: DELETE name: delete description: OVH Cloud Delete a volume call: ovh-cloud-cloud.delete with: serviceName: rest.serviceName volumeId: rest.volumeId outputParameters: - type: object mapping: $. - method: GET name: get description: OVH Cloud Get volume details call: ovh-cloud-cloud.get with: serviceName: rest.serviceName volumeId: rest.volumeId outputParameters: - type: object mapping: $. - method: PUT name: put description: OVH Cloud Update a volume call: ovh-cloud-cloud.put with: serviceName: rest.serviceName volumeId: rest.volumeId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/volume/{volumeid}/attach name: cloud-project-servicename-volume-volumeid-attach description: REST surface for cloud-project-serviceName-volume-volumeId-attach. operations: - method: POST name: post description: OVH Cloud Attach a volume on an instance call: ovh-cloud-cloud.post with: serviceName: rest.serviceName volumeId: rest.volumeId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/volume/{volumeid}/detach name: cloud-project-servicename-volume-volumeid-detach description: REST surface for cloud-project-serviceName-volume-volumeId-detach. operations: - method: POST name: post description: OVH Cloud Detach a volume from an instance call: ovh-cloud-cloud.post with: serviceName: rest.serviceName volumeId: rest.volumeId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/volume/{volumeid}/snapshot name: cloud-project-servicename-volume-volumeid-snapshot description: REST surface for cloud-project-serviceName-volume-volumeId-snapshot. operations: - method: POST name: post description: OVH Cloud Snapshot a volume call: ovh-cloud-cloud.post with: serviceName: rest.serviceName volumeId: rest.volumeId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/volume/{volumeid}/upsize name: cloud-project-servicename-volume-volumeid-upsize description: REST surface for cloud-project-serviceName-volume-volumeId-upsize. operations: - method: POST name: post description: OVH Cloud Extend a volume call: ovh-cloud-cloud.post with: serviceName: rest.serviceName volumeId: rest.volumeId body: rest.body outputParameters: - type: object mapping: $. - path: /v1/cloud/project/{servicename}/vrack name: cloud-project-servicename-vrack description: REST surface for cloud-project-serviceName-vrack. operations: - method: GET name: get description: OVH Cloud Get the linked vRack on your project call: ovh-cloud-cloud.get with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - method: POST name: post description: OVH Cloud Order and attach a new vRack on your project call: ovh-cloud-cloud.post with: serviceName: rest.serviceName outputParameters: - type: object mapping: $. - type: mcp namespace: ovh-cloud-cloud-mcp port: 9090 transport: http description: MCP adapter for OVH Cloud OVHcloud API specification — Cloud. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: ovh-cloud-get-all-cloud description: OVH Cloud Get all cloud pending orders hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: planCode: tools.planCode outputParameters: - type: object mapping: $. - name: ovh-cloud-get-product-availability description: OVH Cloud Get product availability hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: addonFamily: tools.addonFamily ovhSubsidiary: tools.ovhSubsidiary planCode: tools.planCode outputParameters: - type: object mapping: $. - name: ovh-cloud-get-instance-categories description: OVH Cloud Get instance categories hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-services description: OVH Cloud List available services hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: iamTags: tools.iamTags outputParameters: - type: object mapping: $. - name: ovh-cloud-get-this-object description: OVH Cloud Get this object properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-alter-this-object description: OVH Cloud Alter this object properties hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-activate-monthly-billing description: OVH Cloud Activate monthly billing on multiple instances hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-container-registry description: OVH Cloud List container registry capabilities per region hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-admissionplugins-managed description: OVH Cloud List of admissionPlugins managed by MKS product that can be enabled or disabled. hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-kubernetes-available description: OVH Cloud List Kubernetes available flavors for a region hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: region: tools.region serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-log description: OVH Cloud List available log kinds hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-log-kind description: OVH Cloud Get a log kind hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: name: tools.name serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-kubernetes-regions description: OVH Cloud List Kubernetes regions where cluster creation is possible. hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-available description: OVH Cloud List all available regions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-specific-information description: OVH Cloud Get specific information of a region hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-product-availability description: OVH Cloud List product availability hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: addonFamily: tools.addonFamily ovhSubsidiary: tools.ovhSubsidiary planCode: tools.planCode planFamily: tools.planFamily product: tools.product serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-confirm-service-termination description: OVH Cloud Confirm service termination hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-registries-project description: OVH Cloud List registries of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-registry description: OVH Cloud Create a new registry hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-registry description: OVH Cloud Delete a registry hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: registryID: tools.registryID serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-registry-information description: OVH Cloud Get the registry information hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: registryID: tools.registryID serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-registry description: OVH Cloud Update the registry hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: registryID: tools.registryID serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-available-plans description: OVH Cloud Get available plans for the current registry. hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: registryID: tools.registryID serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-ip description: OVH Cloud List your IP restrictions applied on Harbor UI and API hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: registryID: tools.registryID serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-replace-ip-restrictions description: OVH Cloud Replace IP restrictions applied on Harbor UI and API hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: registryID: tools.registryID serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-ip-2 description: OVH Cloud List your IP restrictions applied on artifact manager component hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: registryID: tools.registryID serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-replace-ip-restrictions-2 description: OVH Cloud Replace IP restrictions applied on artifact manager component (Docker, Helm, etc...) hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: registryID: tools.registryID serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-registry-s-oidc description: OVH Cloud Delete the registry's OIDC Configuration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: registryID: tools.registryID serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-registry-s-oidc description: OVH Cloud Get the registry's OIDC configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: registryID: tools.registryID serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-replace-registry-s description: OVH Cloud Add or replace the registry's OIDC configuration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: registryID: tools.registryID serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-edit-registry-s-oidc description: OVH Cloud Edit the registry's OIDC configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: registryID: tools.registryID serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-show-actual-plan description: OVH Cloud Show the actual plan of the registry. hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: registryID: tools.registryID serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-plan-registry description: OVH Cloud Update the plan of a registry. hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: registryID: tools.registryID serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-registry-user description: OVH Cloud List registry user hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: registryID: tools.registryID serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-registry-2 description: OVH Cloud Create a new registry user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: registryID: tools.registryID serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-registry-user description: OVH Cloud Delete a registry user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: registryID: tools.registryID serviceName: tools.serviceName userID: tools.userID outputParameters: - type: object mapping: $. - name: ovh-cloud-get-registry-user description: OVH Cloud Get registry user hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: registryID: tools.registryID serviceName: tools.serviceName userID: tools.userID outputParameters: - type: object mapping: $. - name: ovh-cloud-set-user-admin description: OVH Cloud Set the user as Admin hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: registryID: tools.registryID serviceName: tools.serviceName userID: tools.userID outputParameters: - type: object mapping: $. - name: ovh-cloud-get-database-engines description: OVH Cloud Get database engines availability hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: action: tools.action clusterId: tools.clusterId serviceName: tools.serviceName target: tools.target outputParameters: - type: object mapping: $. - name: ovh-cloud-get-database-engines-2 description: OVH Cloud Get database engines capabilities hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-cassandra description: OVH Cloud List all the cassandra clusters of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-cassandra description: OVH Cloud Create a new cassandra cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-cassandra-cluster description: OVH Cloud Delete a cassandra cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-cassandra-cluster description: OVH Cloud Get cassandra cluster properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-cassandra description: OVH Cloud Update an existing cassandra cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-cassandra-advanced description: OVH Cloud Get cassandra advanced configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-cassandra-advanced description: OVH Cloud Update cassandra advanced configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-backups-cassandra description: OVH Cloud List backups of the cassandra hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-cassandra-backups description: OVH Cloud Get cassandra backups hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: backupId: tools.backupId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-cassandra-advanced-2 description: OVH Cloud Get cassandra advanced configuration fields hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities description: OVH Cloud Get integration capabilities related to the cassandra service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-certificates-cassandra description: OVH Cloud Retrieve the certificates of the cassandra cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-cassandra-ip description: OVH Cloud List cassandra ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-ip-restrictions description: OVH Cloud Add ip restrictions to the cassandra hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-deletes-given-ip description: OVH Cloud Deletes the given IP from the restricted IPs of the cassandra hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-cassandra-ip description: OVH Cloud Get cassandra ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-changes-list-ip description: OVH Cloud Changes the list of ip restrictions to the cassandra hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent description: OVH Cloud Retrieve the most recent cassandra log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-cassandra description: OVH Cloud List maintenances for the cassandra cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-cassandra description: OVH Cloud Get the maintenance for the cassandra cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics description: OVH Cloud List available metrics for the cassandra cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values description: OVH Cloud Get the metric values for the cassandra cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-cassandra description: OVH Cloud List nodes of the cassandra hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-cassandra-nodes description: OVH Cloud Get cassandra nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-users-cassandra description: OVH Cloud List users of the cassandra hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-user description: OVH Cloud Create a new user on the cassandra cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-cassandra-user description: OVH Cloud Delete a cassandra user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-cassandra-users description: OVH Cloud Get cassandra users hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-resets-password-user description: OVH Cloud Resets the password of a user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-grafana description: OVH Cloud List all the grafana of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-grafana description: OVH Cloud Create a new grafana cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-grafana-cluster description: OVH Cloud Delete a grafana cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-grafana-cluster description: OVH Cloud Get grafana cluster properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-grafana description: OVH Cloud Update an existing grafana cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-grafana-advanced description: OVH Cloud Get grafana advanced configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-grafana-advanced description: OVH Cloud Update grafana advanced configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-backups-grafana description: OVH Cloud List backups of the grafana hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-grafana-backups description: OVH Cloud Get grafana backups hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: backupId: tools.backupId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-grafana-advanced-2 description: OVH Cloud Get grafana advanced configuration fields hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities-2 description: OVH Cloud Get integration capabilities related to the grafana service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations-2 description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration-2 description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration-2 description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-2 description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-grafana-ip description: OVH Cloud List grafana ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-ip-restrictions-2 description: OVH Cloud Add ip restrictions to the grafana hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-deletes-given-ip-2 description: OVH Cloud Deletes the given IP from the restricted IPs of the grafana hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-grafana-ip description: OVH Cloud Get grafana ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-changes-list-ip-2 description: OVH Cloud Changes the list of ip restrictions to the grafana hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent-2 description: OVH Cloud Retrieve the most recent grafana log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-grafana description: OVH Cloud List maintenances for the grafana cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-grafana description: OVH Cloud Get the maintenance for the grafana cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance-2 description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-2 description: OVH Cloud List available metrics for the grafana cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values-2 description: OVH Cloud Get the metric values for the grafana cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-grafana description: OVH Cloud List nodes of the grafana hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-grafana-nodes description: OVH Cloud Get grafana nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-users-grafana description: OVH Cloud List users of the grafana hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-grafana-users description: OVH Cloud Get grafana users hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-resets-password-user-2 description: OVH Cloud Resets the password of a user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-kafka description: OVH Cloud List all the kafka of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-kafka description: OVH Cloud Create a new kafka cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-kafka-cluster description: OVH Cloud Delete a kafka cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-cluster description: OVH Cloud Get kafka cluster properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-kafka description: OVH Cloud Update an existing kafka cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-acls-kafka description: OVH Cloud List acls of the kafka hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-acl description: OVH Cloud Create a new acl on the kafka cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-kafka-acl description: OVH Cloud Delete a kafka acl hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: aclId: tools.aclId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-acls description: OVH Cloud Get kafka acls hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: aclId: tools.aclId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-advanced description: OVH Cloud Get kafka advanced configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-kafka-advanced description: OVH Cloud Update kafka advanced configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-advanced-2 description: OVH Cloud Get kafka advanced configuration fields hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities-3 description: OVH Cloud Get integration capabilities related to the kafka service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-certificates-kafka description: OVH Cloud Retrieve the certificates of the kafka cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations-3 description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration-3 description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration-3 description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-3 description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-kafka-ip description: OVH Cloud List kafka ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-ip-restrictions-3 description: OVH Cloud Add ip restrictions to the kafka hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-deletes-given-ip-3 description: OVH Cloud Deletes the given IP from the restricted IPs of the kafka hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-ip description: OVH Cloud Get kafka ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-changes-list-ip-3 description: OVH Cloud Changes the list of ip restrictions to the kafka hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent-3 description: OVH Cloud Retrieve the most recent kafka log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-kafka description: OVH Cloud List maintenances for the kafka cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-kafka description: OVH Cloud Get the maintenance for the kafka cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance-3 description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-3 description: OVH Cloud List available metrics for the kafka cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values-3 description: OVH Cloud Get the metric values for the kafka cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-kafka description: OVH Cloud List nodes of the kafka hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-nodes description: OVH Cloud Get kafka nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-permissions-available description: OVH Cloud Retrieve the permissions available on the cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-schema-registry description: OVH Cloud List schema registry acls of the kafka hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-schema description: OVH Cloud Create a new schema registry acl on the kafka cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-kafka-schema description: OVH Cloud Delete a kafka schema registry acl hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: aclId: tools.aclId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-schema description: OVH Cloud Get kafka schema registry acls hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: aclId: tools.aclId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-topics-kafka description: OVH Cloud List topics of the kafka hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-topic description: OVH Cloud Create a new topic on the kafka cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-kafka-topic description: OVH Cloud Delete a kafka topic hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName topicId: tools.topicId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-topics description: OVH Cloud Get kafka topics hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName topicId: tools.topicId outputParameters: - type: object mapping: $. - name: ovh-cloud-updates-topic-kafka description: OVH Cloud Updates the topic on the kafka cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName topicId: tools.topicId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-topic-acls description: OVH Cloud List topic acls of the kafka hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-topic-2 description: OVH Cloud Create a new topic acl on the kafka cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-kafka-topic-2 description: OVH Cloud Delete a kafka topic acl hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: aclId: tools.aclId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-topic description: OVH Cloud Get kafka topic acls hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: aclId: tools.aclId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-users-kafka description: OVH Cloud List users of the kafka hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-user-2 description: OVH Cloud Create a new user on the kafka cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-kafka-user description: OVH Cloud Delete a kafka user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-users description: OVH Cloud Get kafka users hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-user-acces description: OVH Cloud Retrieve the user acces for the cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-resets-password-user-3 description: OVH Cloud Resets the password of a user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-kafkaconnect description: OVH Cloud List all the kafkaConnect of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-kafkaconnect description: OVH Cloud Create a new kafkaConnect cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-kafkaconnect-cluster description: OVH Cloud Delete a kafkaConnect cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafkaconnect-cluster description: OVH Cloud Get kafkaConnect cluster properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-kafkaconnect description: OVH Cloud Update an existing kafkaConnect cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafkaconnect-advanced description: OVH Cloud Get kafkaConnect advanced configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-kafkaconnect-advanced description: OVH Cloud Update kafkaConnect advanced configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafkaconnect-advanced-2 description: OVH Cloud Get kafkaConnect advanced configuration fields hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-kafka-connect description: OVH Cloud List Kafka Connect connectors hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-connect description: OVH Cloud Get Kafka Connect connector capability hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-connect-2 description: OVH Cloud Get Kafka Connect connector configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafka-connect-3 description: OVH Cloud Get Kafka Connect connector transforms hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities-4 description: OVH Cloud Get integration capabilities related to the kafkaConnect service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-connectors description: OVH Cloud List the connectors hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-connector description: OVH Cloud Create a new connector hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-connector description: OVH Cloud Delete a connector hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-connector description: OVH Cloud Get connector hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-connector description: OVH Cloud Update a connector hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-pause-kafka-connector description: OVH Cloud Pause the kafka connector execution hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-restart-kafka-connector description: OVH Cloud Restart the kafka connector execution hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-resume-kafka-connector description: OVH Cloud Resume the kafka connector execution hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-connector-tasks description: OVH Cloud List the connector tasks hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-connector-task description: OVH Cloud Get connector task hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName taskId: tools.taskId outputParameters: - type: object mapping: $. - name: ovh-cloud-restart-kafka-connector-2 description: OVH Cloud Restart the kafka connector task execution hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId connectorId: tools.connectorId serviceName: tools.serviceName taskId: tools.taskId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations-4 description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration-4 description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration-4 description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-4 description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-kafkaconnect-ip description: OVH Cloud List kafkaConnect ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-ip-restrictions-4 description: OVH Cloud Add ip restrictions to the kafkaConnect hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-deletes-given-ip-4 description: OVH Cloud Deletes the given IP from the restricted IPs of the kafkaConnect hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafkaconnect-ip description: OVH Cloud Get kafkaConnect ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-changes-list-ip-4 description: OVH Cloud Changes the list of ip restrictions to the kafkaConnect hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent-4 description: OVH Cloud Retrieve the most recent kafkaConnect log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-kafka-2 description: OVH Cloud List maintenances for the kafka connect cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-kafka-2 description: OVH Cloud Get the maintenance for the kafka connect cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance-4 description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-4 description: OVH Cloud List available metrics for the kafkaConnect cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values-4 description: OVH Cloud Get the metric values for the kafkaConnect cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-kafkaconnect description: OVH Cloud List nodes of the kafkaConnect hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafkaconnect-nodes description: OVH Cloud Get kafkaConnect nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-users-kafkaconnect description: OVH Cloud List users of the kafkaConnect hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-user-3 description: OVH Cloud Create a new user on the kafkaConnect cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-kafkaconnect-user description: OVH Cloud Delete a kafkaConnect user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafkaconnect-users description: OVH Cloud Get kafkaConnect users hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-resets-password-user-4 description: OVH Cloud Resets the password of a user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-kafkamirrormaker description: OVH Cloud List all the kafkaMirrorMaker of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-kafkamirrormaker description: OVH Cloud Create a new kafkaMirrorMaker hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-kafkamirrormaker description: OVH Cloud Delete a kafkaMirrorMaker hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafkamirrormaker-properties description: OVH Cloud Get kafkaMirrorMaker properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-kafkamirrormaker description: OVH Cloud Update an existing kafkaMirrorMaker hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities-5 description: OVH Cloud Get integration capabilities related to the kafkaMirrorMaker service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations-5 description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration-5 description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration-5 description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-5 description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent-5 description: OVH Cloud Retrieve the most recent kafkaMirrorMaker log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-kafka-3 description: OVH Cloud List maintenances for the kafka mirror maker cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-kafka-3 description: OVH Cloud Get the maintenance for the kafka mirror maker cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance-5 description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-5 description: OVH Cloud List available metrics for the kafkaMirrorMaker hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values-5 description: OVH Cloud Get the metric values for the kafkaMirrorMaker hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-kafkamirrormaker description: OVH Cloud List nodes of the kafkaMirrorMaker hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafkamirrormaker-nodes description: OVH Cloud Get kafkaMirrorMaker nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-replication-kafkamirrormaker description: OVH Cloud List replication of the kafkaMirrorMaker hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-replication description: OVH Cloud Create a new replication hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-replication description: OVH Cloud Delete an replication hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId replicationId: tools.replicationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-kafkamirrormaker-replication description: OVH Cloud Get kafkaMirrorMaker replication hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId replicationId: tools.replicationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-updates-replication description: OVH Cloud Updates a replication hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId replicationId: tools.replicationId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-m3aggregator description: OVH Cloud List all the m3aggregator of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-m3aggregator description: OVH Cloud Create a new m3aggregator hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-m3aggregator description: OVH Cloud Delete a m3aggregator hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-m3aggregator-properties description: OVH Cloud Get m3aggregator properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-m3aggregator description: OVH Cloud Update an existing m3aggregator hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities-6 description: OVH Cloud Get integration capabilities related to the m3aggregator service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations-6 description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration-6 description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration-6 description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-6 description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent-6 description: OVH Cloud Retrieve the most recent m3aggregator log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-m3aggregator description: OVH Cloud List maintenances for the m3aggregator cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-m3aggregator description: OVH Cloud Get the maintenance for the m3aggregator cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance-6 description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-6 description: OVH Cloud List available metrics for the m3aggregator hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values-6 description: OVH Cloud Get the metric values for the m3aggregator hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-m3aggregator description: OVH Cloud List nodes of the m3aggregator hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-m3aggregator-nodes description: OVH Cloud Get m3aggregator nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-m3db description: OVH Cloud List all the m3db clusters of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-m3db description: OVH Cloud Create a new m3db cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-m3db-cluster description: OVH Cloud Delete a m3db cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-m3db-cluster description: OVH Cloud Get m3db cluster properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-m3db description: OVH Cloud Update an existing m3db cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-m3db-advanced description: OVH Cloud Get m3db advanced configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-m3db-advanced description: OVH Cloud Update m3db advanced configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-backups-m3db description: OVH Cloud List backups of the m3db hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-m3db-backups description: OVH Cloud Get m3db backups hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: backupId: tools.backupId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-m3db-advanced-2 description: OVH Cloud Get m3db advanced configuration fields hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities-7 description: OVH Cloud Get integration capabilities related to the m3db service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations-7 description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration-7 description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration-7 description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-7 description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-m3db-ip description: OVH Cloud List m3db ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-ip-restrictions-5 description: OVH Cloud Add ip restrictions to the m3db hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-deletes-given-ip-5 description: OVH Cloud Deletes the given IP from the restricted IPs of the m3db hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-m3db-ip description: OVH Cloud Get m3db ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-changes-list-ip-5 description: OVH Cloud Changes the list of ip restrictions to the m3db hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent-7 description: OVH Cloud Retrieve the most recent m3db log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-m3db description: OVH Cloud List maintenances for the m3db cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-m3db description: OVH Cloud Get the maintenance for the m3db cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance-7 description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-7 description: OVH Cloud List available metrics for the m3db cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values-7 description: OVH Cloud Get the metric values for the m3db cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-namespaces-m3db description: OVH Cloud List namespaces of the m3db hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-namespace description: OVH Cloud Create a new namespace on the m3db cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-m3db-namespace description: OVH Cloud Delete m3db namespace hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId namespaceId: tools.namespaceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-m3db-namespaces description: OVH Cloud Get m3db namespaces hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId namespaceId: tools.namespaceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-updates-namespace-m3db description: OVH Cloud Updates the namespace on the m3db cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId namespaceId: tools.namespaceId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-m3db description: OVH Cloud List nodes of the m3db hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-m3db-nodes description: OVH Cloud Get m3db nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-users-m3db description: OVH Cloud List users of the m3db hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-user-4 description: OVH Cloud Create a new user on the m3db cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-m3db-user description: OVH Cloud Delete m3db user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-m3db-users description: OVH Cloud Get m3db users hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-updates-user-m3db description: OVH Cloud Updates the user on the m3db cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-resets-password-user-5 description: OVH Cloud Resets the password of a user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-mysql description: OVH Cloud List all the mysql of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-mysql description: OVH Cloud Create a new mysql cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-mysql-cluster description: OVH Cloud Delete a mysql cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-mysql-cluster description: OVH Cloud Get mysql cluster properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-mysql description: OVH Cloud Update an existing mysql cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-mysql-advanced description: OVH Cloud Get mysql advanced configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-mysql-advanced description: OVH Cloud Update mysql advanced configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-backups-mysql description: OVH Cloud List backups of the mysql hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-mysql-backups description: OVH Cloud Get mysql backups hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: backupId: tools.backupId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-mysql-advanced-2 description: OVH Cloud Get mysql advanced configuration fields hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities-8 description: OVH Cloud Get integration capabilities related to the mysql service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-certificates-mysql description: OVH Cloud Retrieve the certificates of the mysql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-current-queries description: OVH Cloud Retrieve the current queries for the cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId limit: tools.limit offset: tools.offset serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-cancel-given-current description: OVH Cloud Cancel the given current query of the cluster hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: get description: get hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-database description: OVH Cloud Create a new database on the mysql cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-mysql-database description: OVH Cloud Delete a mysql database hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId databaseId: tools.databaseId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-database-mysql description: OVH Cloud Get the database for the mysql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId databaseId: tools.databaseId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-enable-temporary-write description: OVH Cloud Enable temporary write permission on readonly lock mysql service hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations-8 description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration-8 description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration-8 description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-8 description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-mysql-ip description: OVH Cloud List mysql ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-ip-restrictions-6 description: OVH Cloud Add ip restrictions to the mysql hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-deletes-given-ip-6 description: OVH Cloud Deletes the given IP from the restricted IPs of the mysql hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-mysql-ip description: OVH Cloud Get mysql ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-changes-list-ip-6 description: OVH Cloud Changes the list of ip restrictions to the mysql hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent-8 description: OVH Cloud Retrieve the most recent mysql log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-mysql description: OVH Cloud List maintenances for the mysql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-mysql description: OVH Cloud Get the maintenance for the mysql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance-8 description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-8 description: OVH Cloud List available metrics for the mysql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values-8 description: OVH Cloud Get the metric values for the mysql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-mysql description: OVH Cloud List nodes of the mysql hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-mysql-nodes description: OVH Cloud Get mysql nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-query-statistics description: OVH Cloud Retrieve the query statistics for the cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId limit: tools.limit offset: tools.offset serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-reset-query-statistics description: OVH Cloud Reset the query statistics of the cluster hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-users-mysql description: OVH Cloud List users of the mysql hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-user-5 description: OVH Cloud Create a new user on the mysql cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-mysql-user description: OVH Cloud Delete a mysql user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-mysql-users description: OVH Cloud Get mysql users hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-resets-password-user-6 description: OVH Cloud Resets the password of a user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-opensearch description: OVH Cloud List all the opensearch of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-opensearch description: OVH Cloud Create a new opensearch cluster hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-opensearch-cluster description: OVH Cloud Delete a opensearch cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-opensearch-cluster description: OVH Cloud Get opensearch cluster properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-opensearch description: OVH Cloud Update an existing opensearch cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-opensearch-advanced description: OVH Cloud Get opensearch advanced configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-opensearch-advanced description: OVH Cloud Update opensearch advanced configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-backups-opensearch description: OVH Cloud List backups of the opensearch hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-opensearch-backups description: OVH Cloud Get opensearch backups hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: backupId: tools.backupId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-opensearch-advanced-2 description: OVH Cloud Get opensearch advanced configuration fields hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities-9 description: OVH Cloud Get integration capabilities related to the opensearch service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-indexes-opensearch description: OVH Cloud List indexes of the opensearch hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-opensearch-index description: OVH Cloud Delete an opensearch index hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId indexId: tools.indexId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-opensearch-index description: OVH Cloud Get opensearch index hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId indexId: tools.indexId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations-9 description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration-9 description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration-9 description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-9 description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-opensearch-ip description: OVH Cloud List opensearch ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-ip-restrictions-7 description: OVH Cloud Add ip restrictions to the opensearch hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-deletes-given-ip-7 description: OVH Cloud Deletes the given IP from the restricted IPs of the opensearch hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-opensearch-ip description: OVH Cloud Get opensearch ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-changes-list-ip-7 description: OVH Cloud Changes the list of ip restrictions to the opensearch hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent-9 description: OVH Cloud Retrieve the most recent opensearch log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-opensearch description: OVH Cloud List maintenances for the opensearch cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-opensearch description: OVH Cloud Get the maintenance for the opensearch cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance-9 description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-9 description: OVH Cloud List available metrics for the opensearch cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values-9 description: OVH Cloud Get the metric values for the opensearch cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-opensearch description: OVH Cloud List nodes of the opensearch hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-opensearch-nodes description: OVH Cloud Get opensearch nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-patterns-opensearch description: OVH Cloud List patterns of the opensearch hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-pattern description: OVH Cloud Create a new pattern on the opensearch cluster hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-opensearch-pattern description: OVH Cloud Delete an opensearch pattern hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId patternId: tools.patternId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-opensearch-patterns description: OVH Cloud Get opensearch patterns hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId patternId: tools.patternId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-opensearch-permissions description: OVH Cloud Retrieve the opensearch permissions values hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-users-opensearch description: OVH Cloud List users of the opensearch hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-user-6 description: OVH Cloud Create a new user on the opensearch cluster hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-opensearch-user description: OVH Cloud Delete a opensearch user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-opensearch-users description: OVH Cloud Get opensearch users hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-update-user-opensearch description: OVH Cloud Update a user on the opensearch cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-resets-password-user-7 description: OVH Cloud Resets the password of a user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-postgresql description: OVH Cloud List all the postgresql of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-postgresql description: OVH Cloud Create a new postgresql cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-postgresql-cluster description: OVH Cloud Delete a postgresql cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-postgresql-cluster description: OVH Cloud Get postgresql cluster properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-postgresql description: OVH Cloud Update an existing postgresql cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-postgresql-advanced description: OVH Cloud Get postgresql advanced configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-postgresql-advanced description: OVH Cloud Update postgresql advanced configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-backups-postgresql description: OVH Cloud List backups of the postgresql hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-postgresql-backups description: OVH Cloud Get postgresql backups hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: backupId: tools.backupId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-postgresql-advanced-2 description: OVH Cloud Get postgresql advanced configuration fields hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities-10 description: OVH Cloud Get integration capabilities related to the postgresql service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-certificates-postgresql description: OVH Cloud Retrieve the certificates of the postgresql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: get-2 description: get hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-connectionpool description: OVH Cloud Create a new connectionPool on the postgresql cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-postgresql-connectionpool description: OVH Cloud Delete a postgresql connectionPool hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId connectionPoolId: tools.connectionPoolId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-connectionpool-postgresql description: OVH Cloud Get the connectionPool for the postgresql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId connectionPoolId: tools.connectionPoolId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-connectionpool-postgresql description: OVH Cloud Update a connectionPool on the postgresql cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId connectionPoolId: tools.connectionPoolId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-current-queries-2 description: OVH Cloud Retrieve the current queries for the cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId limit: tools.limit offset: tools.offset serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-cancel-given-current-2 description: OVH Cloud Cancel the given current query of the cluster hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: get-3 description: get hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-database-2 description: OVH Cloud Create a new database on the postgresql cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-postgresql-database description: OVH Cloud Delete a postgresql database hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId databaseId: tools.databaseId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-database-postgresql description: OVH Cloud Get the database for the postgresql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId databaseId: tools.databaseId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-enable-temporary-write-2 description: OVH Cloud Enable temporary write permission on readonly lock postgresql service hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations-10 description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration-10 description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration-10 description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-10 description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-postgresql-ip description: OVH Cloud List postgresql ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-ip-restrictions-8 description: OVH Cloud Add ip restrictions to the postgresql hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-deletes-given-ip-8 description: OVH Cloud Deletes the given IP from the restricted IPs of the postgresql hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-postgresql-ip description: OVH Cloud Get postgresql ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-changes-list-ip-8 description: OVH Cloud Changes the list of ip restrictions to the postgresql hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent-10 description: OVH Cloud Retrieve the most recent postgresql log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-postgresql description: OVH Cloud List maintenances for the postgresql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-postgresql description: OVH Cloud Get the maintenance for the postgresql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance-10 description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-10 description: OVH Cloud List available metrics for the postgresql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values-10 description: OVH Cloud Get the metric values for the postgresql cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-postgresql description: OVH Cloud List nodes of the postgresql hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-postgresql-nodes description: OVH Cloud Get postgresql nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-query-statistics-2 description: OVH Cloud Retrieve the query statistics for the cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId limit: tools.limit offset: tools.offset serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-reset-query-statistics-2 description: OVH Cloud Reset the query statistics of the cluster hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-postgresql-roles description: OVH Cloud Get postgresql roles hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-users-postgresql description: OVH Cloud List users of the postgresql hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-user-7 description: OVH Cloud Create a new user on the postgresql cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-postgresql-user description: OVH Cloud Delete a postgresql user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-postgresql-users description: OVH Cloud Get postgresql users hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-updates-user-postgresql description: OVH Cloud Updates the user on the postgresql cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-resets-password-user-8 description: OVH Cloud Resets the password of a user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-redis description: OVH Cloud List all the redis of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-redis description: OVH Cloud Create a new redis cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-redis-cluster description: OVH Cloud Delete a redis cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-redis-cluster description: OVH Cloud Get redis cluster properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-existing-redis description: OVH Cloud Update an existing redis cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-redis-advanced description: OVH Cloud Get redis advanced configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-redis-advanced description: OVH Cloud Update redis advanced configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-backups-redis description: OVH Cloud List backups of the redis hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-redis-backups description: OVH Cloud Get redis backups hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: backupId: tools.backupId clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-redis-advanced-2 description: OVH Cloud Get redis advanced configuration fields hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-available-categories description: OVH Cloud Get available categories in the redis service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-available-commands description: OVH Cloud Get available commands in the redis service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-capabilities-11 description: OVH Cloud Get integration capabilities related to the redis service hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-integrations-11 description: OVH Cloud List integrations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-integration-11 description: OVH Cloud Create a new integration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-integration-11 description: OVH Cloud Delete an integration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-integration-11 description: OVH Cloud Get an integration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId integrationId: tools.integrationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-redis-ip description: OVH Cloud List redis ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-ip-restrictions-9 description: OVH Cloud Add ip restrictions to the redis hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-deletes-given-ip-9 description: OVH Cloud Deletes the given IP from the restricted IPs of the redis hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-redis-ip description: OVH Cloud Get redis ip restrictions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-changes-list-ip-9 description: OVH Cloud Changes the list of ip restrictions to the redis hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId ipBlock: tools.ipBlock serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-retrieve-most-recent-11 description: OVH Cloud Retrieve the most recent redis log messages (limited to 1000) hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-maintenances-redis description: OVH Cloud List maintenances for the redis cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-maintenance-redis description: OVH Cloud Get the maintenance for the redis cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-maintenance-11 description: OVH Cloud Apply the maintenance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId maintenanceId: tools.maintenanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-11 description: OVH Cloud List available metrics for the redis cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId extended: tools.extended serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-metric-values-11 description: OVH Cloud Get the metric values for the redis cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId metricName: tools.metricName period: tools.period serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-nodes-redis description: OVH Cloud List nodes of the redis hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-redis-nodes description: OVH Cloud Get redis nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-users-redis description: OVH Cloud List users of the redis hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-user-8 description: OVH Cloud Create a new user on the redis cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-redis-user description: OVH Cloud Delete a redis user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-redis-users description: OVH Cloud Get redis users hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-update-user-redis description: OVH Cloud Update a user on the redis cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-resets-password-user-9 description: OVH Cloud Resets the password of a user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: clusterId: tools.clusterId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-database-services description: OVH Cloud List database services of the project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: category: tools.category serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-service-cluster description: OVH Cloud Get service cluster properties hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: clusterId: tools.clusterId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-flavors description: OVH Cloud Get flavors hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: region: tools.region serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-flavor description: OVH Cloud Get flavor hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: flavorId: tools.flavorId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-images description: OVH Cloud Get images hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: flavorType: tools.flavorType osType: tools.osType region: tools.region serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-image description: OVH Cloud Get image hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: imageId: tools.imageId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-instance description: OVH Cloud Get instance hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: region: tools.region serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-instance description: OVH Cloud Create a new instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-create-multiple-instances description: OVH Cloud Create multiple instances hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-detail-group description: OVH Cloud Get the detail of a group hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: region: tools.region serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-group description: OVH Cloud Create a group hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-group description: OVH Cloud Delete a group hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: groupId: tools.groupId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-all-groups description: OVH Cloud Get all groups hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: groupId: tools.groupId region: tools.region serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-instance description: OVH Cloud Delete an instance hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-instance-2 description: OVH Cloud Get instance hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-alter-instance description: OVH Cloud Alter an instance hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: instanceId: tools.instanceId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-activate-monthly-billing-2 description: OVH Cloud Activate monthly billing on instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-return-initial-credentials description: OVH Cloud Return initial credentials of applications installed from public image hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-interfaces description: OVH Cloud Get interfaces hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-interface-instance description: OVH Cloud Create interface on an instance and attached it to a network hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-interface description: OVH Cloud Delete an interface hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: instanceId: tools.instanceId interfaceId: tools.interfaceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-interface description: OVH Cloud Get interface hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: instanceId: tools.instanceId interfaceId: tools.interfaceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-return-many-statistics description: OVH Cloud Return many statistics about the virtual machine for a given period hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: instanceId: tools.instanceId period: tools.period serviceName: tools.serviceName type: tools.type outputParameters: - type: object mapping: $. - name: ovh-cloud-reboot-instance description: OVH Cloud Reboot an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-reinstall-instance description: OVH Cloud Reinstall an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-enable-disable-rescue description: OVH Cloud Enable or disable rescue mode hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-migrate-your-instance description: OVH Cloud Migrate your instance to another flavor hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-resume-suspended-instance description: OVH Cloud Resume a suspended instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-shelve-instance description: OVH Cloud Shelve an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-snapshot-instance description: OVH Cloud Snapshot an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-start-instance description: OVH Cloud Start an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-stop-instance description: OVH Cloud Stop an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-unshelve-instance description: OVH Cloud Unshelve an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-vnc-access description: OVH Cloud Get VNC access to your instance hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-ips description: OVH Cloud Get ips hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-failover-ips description: OVH Cloud Get failover ips hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-failover-ip description: OVH Cloud Get failover ip hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: id: tools.id serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-attach-failover-ip description: OVH Cloud Attach failover ip to an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: id: tools.id serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-managed description: OVH Cloud List your managed Kubernetes clusters hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-managed description: OVH Cloud Create a new managed Kubernetes cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-kubernetes-available-2 description: OVH Cloud List Kubernetes available regions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-your-managed description: OVH Cloud Delete your managed Kubernetes cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-information-about description: OVH Cloud Get information about your managed Kubernetes cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-information-about description: OVH Cloud Update information about your managed Kubernetes cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-generate-temporary-url description: OVH Cloud Generate a temporary URL to retrieve audit logs hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-cluster-customization description: OVH Cloud Get cluster customization hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-cluster-customization description: OVH Cloud Update cluster customization hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-flavors description: OVH Cloud List all flavors available hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-ip-3 description: OVH Cloud List your ip restrictions on your cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-append-list-ip description: OVH Cloud Append a list of ip restrictions on your cluster hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-remove-current-list description: OVH Cloud Remove the current list and add a list of ip restrictions on your cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-ip-restriction description: OVH Cloud Delete an ip restriction from your cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: ip: tools.ip kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-generate-kubeconfig-file description: OVH Cloud Generate kubeconfig file hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-reset-kubeconfig-certificates description: 'OVH Cloud Reset kubeconfig: Certificates will be regenerated, nodes will be reinstalled' hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-generate-temporary-url-2 description: OVH Cloud Generate a temporary URL to retrieve logs hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-metrics-12 description: OVH Cloud List available metrics for this cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-nodes description: OVH Cloud List your nodes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-specific-node description: OVH Cloud Delete a specific node on your cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: kubeId: tools.kubeId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-information-specific description: OVH Cloud Get information on a specific node on your cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId nodeId: tools.nodeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-nodepools description: OVH Cloud List your nodepools hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-nodepool-your description: OVH Cloud Create a nodepool on your cluster hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-nodepool-your description: OVH Cloud Delete a nodepool from your cluster hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: kubeId: tools.kubeId nodePoolId: tools.nodePoolId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-information-specific-2 description: OVH Cloud Get information on a specific nodepool on your cluster hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId nodePoolId: tools.nodePoolId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-your-nodepool description: OVH Cloud Update your nodepool information hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: kubeId: tools.kubeId nodePoolId: tools.nodePoolId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-nodes description: OVH Cloud List all nodes contained in a nodepool hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId nodePoolId: tools.nodePoolId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-remove-openidconnect-integration description: OVH Cloud Remove OpenIdConnect integration from APIServer hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-openidconnect-integration description: OVH Cloud Get openIdConnect integration parameters hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-configure-apiserver-openidconnect description: OVH Cloud Configure APIServer for OpenIdConnect hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-update-parameters-and description: OVH Cloud Update parameters and reconfigure APIServer hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-private-network description: OVH Cloud Get private network configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: kubeId: tools.kubeId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-private-network description: OVH Cloud Update private network configuration hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-reset-cluster-all description: 'OVH Cloud Reset cluster: all Kubernetes data will be erased (pods, services, configuration, etc), nodes will be either deleted or reinstalled' hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-restarting-your-control description: OVH Cloud Restarting your control plane apiserver to invalidate cache without downtime (using force will create a slight downtime) hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-force-cluster-and description: OVH Cloud Force cluster and node update to the latest patch within minor version or next minor version hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-updates-load-balancers description: OVH Cloud Updates the load balancers subnet ID hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-change-update-policy description: OVH Cloud Change the update policy of your cluster hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: kubeId: tools.kubeId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-available-public description: OVH Cloud List available public cloud labs hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-public description: OVH Cloud Get details of a public cloud lab hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: labId: tools.labId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-activate-lab-your description: OVH Cloud Activate a lab on your Cloud Project hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: labId: tools.labId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-required-agreements description: OVH Cloud List required agreements to active this lab hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: labId: tools.labId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-load description: OVH Cloud List all load balancer for a tenant hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.listloadbalancers with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-load-balancer description: OVH Cloud Create a load balancer hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.createloadbalancer with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-load-balancer description: OVH Cloud Delete a load balancer hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.deleteloadbalancer with: loadBalancerId: tools.loadBalancerId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-load-balancer description: OVH Cloud Get a load balancer hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.getloadbalancer with: loadBalancerId: tools.loadBalancerId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-load-balancer description: OVH Cloud Update a load balancer hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.updateloadbalancer with: loadBalancerId: tools.loadBalancerId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-all-versions description: OVH Cloud List all versions of the configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.listloadbalancerconfigurations with: loadBalancerId: tools.loadBalancerId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-configuration description: OVH Cloud Create a configuration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.createloadbalancerconfiguration with: loadBalancerId: tools.loadBalancerId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-configuration description: OVH Cloud Delete a configuration hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.deleteloadbalancerconfiguration with: loadBalancerId: tools.loadBalancerId serviceName: tools.serviceName version: tools.version outputParameters: - type: object mapping: $. - name: ovh-cloud-get-configuration description: OVH Cloud Get a configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.getloadbalancerconfiguration with: loadBalancerId: tools.loadBalancerId serviceName: tools.serviceName version: tools.version outputParameters: - type: object mapping: $. - name: ovh-cloud-apply-configuration description: OVH Cloud Apply a configuration hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.applyloadbalancerconfiguration with: loadBalancerId: tools.loadBalancerId serviceName: tools.serviceName version: tools.version outputParameters: - type: object mapping: $. - name: ovh-cloud-get-private-networks description: OVH Cloud Get private networks hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-network description: OVH Cloud Create a new network hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-private-network description: OVH Cloud Delete private network hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: networkId: tools.networkId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-private-network-2 description: OVH Cloud Get private network hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: networkId: tools.networkId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-rename-private-network description: OVH Cloud Rename private network hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: networkId: tools.networkId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-activate-private-network description: OVH Cloud Activate private network in a new region hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: networkId: tools.networkId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-network-subnets description: OVH Cloud Get network subnets hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: networkId: tools.networkId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-network-2 description: OVH Cloud Create a new network subnet hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: networkId: tools.networkId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-network-subnet description: OVH Cloud Delete a network subnet hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: networkId: tools.networkId serviceName: tools.serviceName subnetId: tools.subnetId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-public-networks description: OVH Cloud Get public networks hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-operations description: OVH Cloud List your operations hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-information-about-2 description: OVH Cloud Get information about one operation hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: operationId: tools.operationId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-quotas description: OVH Cloud List quotas hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-regions description: OVH Cloud List your regions hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-request-access-region description: OVH Cloud Request access to a region hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-information-about-3 description: OVH Cloud Get information about your region hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-floating-ips description: OVH Cloud Get floating ips hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-floating-ip description: OVH Cloud Delete a floating ip hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: floatingIpId: tools.floatingIpId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-floating-ip description: OVH Cloud Get a floating ip hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: floatingIpId: tools.floatingIpId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-detach-your-floating description: OVH Cloud Detach your floating ip hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: floatingIpId: tools.floatingIpId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-gateways description: OVH Cloud List gateways hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName subnetId: tools.subnetId outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-gateway description: OVH Cloud Create new Gateway and new Private Network with new Subnet hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-gateway description: OVH Cloud Delete gateway hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: id: tools.id regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-gateway description: OVH Cloud Get gateway hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: id: tools.id regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-gateway description: OVH Cloud Update a gateway hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: id: tools.id regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-expose-gateway-public description: OVH Cloud Expose gateway to public network by adding a public port on it. hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: id: tools.id regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-interfaces description: OVH Cloud List interfaces hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: id: tools.id regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-gateway-interface description: OVH Cloud Create gateway interface hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: id: tools.id regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-gateway-interface description: OVH Cloud Delete gateway interface hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: id: tools.id interfaceId: tools.interfaceId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-interface-2 description: OVH Cloud Get interface hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: id: tools.id interfaceId: tools.interfaceId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-abort-instance-snapshot description: OVH Cloud Abort an instance snapshot creation hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-associate-existing-floating description: OVH Cloud Associate an existing floating IP to an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-create-floating-ip description: OVH Cloud Create a floating IP and attach it to an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: instanceId: tools.instanceId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-certificates description: OVH Cloud List certificates hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-certificate description: OVH Cloud Create a new certificate hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-certificate description: OVH Cloud Delete a certificate hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: certificateId: tools.certificateId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-about description: OVH Cloud Get details about a certificate hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: certificateId: tools.certificateId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-secrets description: OVH Cloud List secrets hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-secret description: OVH Cloud Delete a secret hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: regionName: tools.regionName secretId: tools.secretId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-about-2 description: OVH Cloud Get details about a secret hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName secretId: tools.secretId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-flavors description: OVH Cloud List flavors hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-about-3 description: OVH Cloud Get details about a load balancing flavor hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: flavorId: tools.flavorId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-health-monitors description: OVH Cloud List health monitors hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: poolId: tools.poolId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-health-monitor description: OVH Cloud Create health monitor hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-health-monitor description: OVH Cloud Delete health monitor hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: healthMonitorId: tools.healthMonitorId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-about-4 description: OVH Cloud Get details about a loadbalancer health monitor hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: healthMonitorId: tools.healthMonitorId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-health-monitor description: OVH Cloud Update a health monitor hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: healthMonitorId: tools.healthMonitorId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: get-4 description: get hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: listenerId: tools.listenerId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: post description: post hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: delete description: delete hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: l7PolicyId: tools.l7PolicyId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: get-5 description: get hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: l7PolicyId: tools.l7PolicyId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: put description: put hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: l7PolicyId: tools.l7PolicyId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: get-6 description: get hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: l7PolicyId: tools.l7PolicyId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: post-2 description: post hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: l7PolicyId: tools.l7PolicyId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: delete-2 description: delete hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: l7PolicyId: tools.l7PolicyId l7RuleId: tools.l7RuleId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: get-7 description: get hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: l7PolicyId: tools.l7PolicyId l7RuleId: tools.l7RuleId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: put-2 description: put hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: l7PolicyId: tools.l7PolicyId l7RuleId: tools.l7RuleId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-loadbalancer description: OVH Cloud List your loadbalancer listeners hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: loadbalancerId: tools.loadbalancerId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-loadbalancer-listener description: OVH Cloud Create a loadbalancer listener hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-loadbalancer-listener description: OVH Cloud Delete loadbalancer listener hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: listenerId: tools.listenerId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-about-5 description: OVH Cloud Get details about a loadbalancer listener hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: listenerId: tools.listenerId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-edit-loadbalancer-listener description: OVH Cloud Edit a loadbalancer listener hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: listenerId: tools.listenerId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-load description: OVH Cloud List your load balancers hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-loadbalancer description: OVH Cloud Create a loadbalancer hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-loadbalancer description: OVH Cloud Delete loadbalancer hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: loadBalancerId: tools.loadBalancerId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-about-6 description: OVH Cloud Get details about a load balancer hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: loadBalancerId: tools.loadBalancerId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-edit-loadbalancer description: OVH Cloud Edit a loadbalancer hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: loadBalancerId: tools.loadBalancerId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-associate-existing-floating-2 description: OVH Cloud Associate an existing floating IP to a loadbalancer hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: loadBalancerId: tools.loadBalancerId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-create-floating-ip-2 description: OVH Cloud Create a floating IP and attach it to a loadbalancer hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: loadBalancerId: tools.loadBalancerId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-loadbalancer-statistics description: OVH Cloud Get loadbalancer statistics hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: loadBalancerId: tools.loadBalancerId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-loadbalancer-2 description: OVH Cloud List your loadbalancer pools hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: loadbalancerId: tools.loadbalancerId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-loadbalancer-pool description: OVH Cloud Create a loadbalancer pool hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-loadbalancer-pool description: OVH Cloud Delete a loadbalancer pool hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: poolId: tools.poolId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-about-7 description: OVH Cloud Get details about a loadbalancer pool hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: poolId: tools.poolId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-loadbalancer-pool description: OVH Cloud Update a loadbalancer pool hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: poolId: tools.poolId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-pool description: OVH Cloud List your pool members hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: poolId: tools.poolId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-pool-members description: OVH Cloud Create pool members hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: poolId: tools.poolId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-pool-member description: OVH Cloud Delete a pool member hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: memberId: tools.memberId poolId: tools.poolId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-about-8 description: OVH Cloud Get details about a pool member hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: memberId: tools.memberId poolId: tools.poolId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-pool-member description: OVH Cloud Update a pool member hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: memberId: tools.memberId poolId: tools.poolId regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-networks description: OVH Cloud List networks hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-network-gateway description: OVH Cloud Create a network with a gateway hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-network description: OVH Cloud Delete network hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: networkId: tools.networkId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-network description: OVH Cloud Get network hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: networkId: tools.networkId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-subnets description: OVH Cloud List subnets hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: networkId: tools.networkId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-subnet description: OVH Cloud Delete subnet hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: networkId: tools.networkId regionName: tools.regionName serviceName: tools.serviceName subnetId: tools.subnetId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-subnet description: OVH Cloud Get subnet hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: networkId: tools.networkId regionName: tools.regionName serviceName: tools.serviceName subnetId: tools.subnetId outputParameters: - type: object mapping: $. - name: ovh-cloud-create-gateway-existing description: OVH Cloud Create Gateway for existing subnet hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: networkId: tools.networkId regionName: tools.regionName serviceName: tools.serviceName subnetId: tools.subnetId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-quotas-2 description: OVH Cloud List quotas hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-change-project-quotas description: OVH Cloud Change project quotas on region hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-allowed-quotas description: OVH Cloud Get allowed quotas on region hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-storage-quota description: OVH Cloud Delete storage quota on region hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-storage-quotas description: OVH Cloud Get storage quotas on region hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-storage-quota description: OVH Cloud Update storage quota on region hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-s3-storage description: OVH Cloud Get S3 storage containers hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-s3-storage description: OVH Cloud Create S3 storage container hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-s3-storage description: OVH Cloud Delete S3 storage container hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: name: tools.name regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-s3-storage-2 description: OVH Cloud Get S3 storage container hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: limit: tools.limit marker: tools.marker name: tools.name prefix: tools.prefix regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-s3-storage description: OVH Cloud Update S3 storage container hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: name: tools.name regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-s3-storage-2 description: OVH Cloud Delete S3 storage container object hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: name: tools.name objectKey: tools.objectKey regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-s3-storage description: OVH Cloud Add S3 storage container policy hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: name: tools.name regionName: tools.regionName serviceName: tools.serviceName userId: tools.userId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-generate-s3-presigned description: OVH Cloud Generate S3 presigned URLs to download or upload objects hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: name: tools.name regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-volume-backups description: OVH Cloud List volume backups hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-volume-backup description: OVH Cloud Create a volume backup hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-volume-backup description: OVH Cloud Delete volume backup hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: regionName: tools.regionName serviceName: tools.serviceName volumeBackupId: tools.volumeBackupId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-volume-backup description: OVH Cloud Get volume backup hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName volumeBackupId: tools.volumeBackupId outputParameters: - type: object mapping: $. - name: ovh-cloud-restore-volume-backup description: OVH Cloud Restore a volume backup on a volume hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName volumeBackupId: tools.volumeBackupId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-create-volume-volume description: OVH Cloud Create a volume from a volume backup hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName volumeBackupId: tools.volumeBackupId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-automated description: OVH Cloud List your automated backups hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-automated description: OVH Cloud Create a new automated backup hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: regionName: tools.regionName serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-backup-workflow description: OVH Cloud Delete a backup workflow process hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: backupWorkflowId: tools.backupWorkflowId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-about-9 description: OVH Cloud Get details about a backup workflow process hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: backupWorkflowId: tools.backupWorkflowId regionName: tools.regionName serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-regions-which description: OVH Cloud List the regions on which you can ask an access to hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-all-roles description: OVH Cloud Get all Roles hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-service-information description: OVH Cloud Get service information hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-service-information description: OVH Cloud Update service information hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-snapshots description: OVH Cloud Get snapshots hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: flavorType: tools.flavorType region: tools.region serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-snapshot description: OVH Cloud Delete a snapshot hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: imageId: tools.imageId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-snapshot-details description: OVH Cloud Get snapshot details hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: imageId: tools.imageId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-ssh-keys description: OVH Cloud Get SSH keys hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: region: tools.region serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-ssh-key description: OVH Cloud Create SSH key hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-ssh-key description: OVH Cloud Delete SSH key hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: keyId: tools.keyId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-ssh-key description: OVH Cloud Get SSH key hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: keyId: tools.keyId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-stacks description: OVH Cloud Get stacks hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-stack description: OVH Cloud Get stack hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName stackId: tools.stackId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-swift-storage description: OVH Cloud Get SWIFT storage containers hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: includeType: tools.includeType serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-swift-container description: OVH Cloud Create SWIFT container hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-access-swift-storage description: OVH Cloud Access to SWIFT storage API hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-list-storage-quotas description: OVH Cloud List storage quotas hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-swift-container description: OVH Cloud Delete SWIFT container hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: containerId: tools.containerId recursive: tools.recursive serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-swift-storage-2 description: OVH Cloud Get SWIFT storage container hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: containerId: tools.containerId noObjects: tools.noObjects prefix: tools.prefix serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-update-swift-storage description: OVH Cloud Update SWIFT storage container hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: containerId: tools.containerId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-cors-support description: OVH Cloud Delete CORS support on SWIFT container hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: containerId: tools.containerId origin: tools.origin serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-add-cors-support description: OVH Cloud Add CORS support on SWIFT container hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: containerId: tools.containerId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-public-temporary description: OVH Cloud Get a public temporary URL to access one of your SWIFT object hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: containerId: tools.containerId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-deploy-your-swift description: OVH Cloud Deploy your SWIFT container files as a static web site hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: containerId: tools.containerId serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-openstack-user description: OVH Cloud Create openstack user with only access to this SWIFT container hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: containerId: tools.containerId serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-ask-termination-your description: OVH Cloud Ask for the termination of your service hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-get-all-users description: OVH Cloud Get all users hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-user description: OVH Cloud Create user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-user description: OVH Cloud Delete user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-user-details description: OVH Cloud Get user details hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-your-client description: OVH Cloud Get your client configuration hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: region: tools.region serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-rc-file description: OVH Cloud Get RC file of OpenStack hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: region: tools.region serviceName: tools.serviceName userId: tools.userId version: tools.version outputParameters: - type: object mapping: $. - name: ovh-cloud-export-user-storage description: OVH Cloud Export user storage policy hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-import-user-storage description: OVH Cloud Import user storage policy hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName userId: tools.userId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-rclone-configuration description: OVH Cloud Get rclone configuration file hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: region: tools.region service: tools.service serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-regenerate-user-password description: OVH Cloud Regenerate user password hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-user-roles description: OVH Cloud Get user roles hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-add-role-user description: OVH Cloud Add a role to a user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName userId: tools.userId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-update-roles-user description: OVH Cloud Update roles of a user hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: serviceName: tools.serviceName userId: tools.userId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-remove-role-user description: OVH Cloud Remove role for a user hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: roleId: tools.roleId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-role-detail description: OVH Cloud Get role detail hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: roleId: tools.roleId serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-list-your-s3 description: OVH Cloud List your S3 credentials hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-create-new-s3 description: OVH Cloud Create a new S3 credentials for an user hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-s3-credential description: OVH Cloud Delete an S3 credential hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: access: tools.access serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-details-about-10 description: OVH Cloud Get details about an S3 credential hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: access: tools.access serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-display-secret-s3 description: OVH Cloud Display secret from a S3 credential hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: access: tools.access serviceName: tools.serviceName userId: tools.userId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-token-user description: OVH Cloud Get token for user hints: readOnly: true destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName userId: tools.userId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-volumes description: OVH Cloud Get volumes hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: region: tools.region serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-create-volume description: OVH Cloud Create a volume hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-volume-snapshots description: OVH Cloud Get volume snapshots hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: region: tools.region serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-volume-snapshot description: OVH Cloud Delete a volume snapshot hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: serviceName: tools.serviceName snapshotId: tools.snapshotId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-volume-snapshot description: OVH Cloud Get volume snapshot details hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName snapshotId: tools.snapshotId outputParameters: - type: object mapping: $. - name: ovh-cloud-delete-volume description: OVH Cloud Delete a volume hints: readOnly: false destructive: true idempotent: true call: ovh-cloud-cloud.delete with: serviceName: tools.serviceName volumeId: tools.volumeId outputParameters: - type: object mapping: $. - name: ovh-cloud-get-volume-details description: OVH Cloud Get volume details hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName volumeId: tools.volumeId outputParameters: - type: object mapping: $. - name: ovh-cloud-update-volume description: OVH Cloud Update a volume hints: readOnly: false destructive: false idempotent: true call: ovh-cloud-cloud.put with: serviceName: tools.serviceName volumeId: tools.volumeId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-attach-volume-instance description: OVH Cloud Attach a volume on an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName volumeId: tools.volumeId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-detach-volume-instance description: OVH Cloud Detach a volume from an instance hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName volumeId: tools.volumeId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-snapshot-volume description: OVH Cloud Snapshot a volume hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName volumeId: tools.volumeId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-extend-volume description: OVH Cloud Extend a volume hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName volumeId: tools.volumeId body: tools.body outputParameters: - type: object mapping: $. - name: ovh-cloud-get-linked-vrack description: OVH Cloud Get the linked vRack on your project hints: readOnly: true destructive: false idempotent: true call: ovh-cloud-cloud.get with: serviceName: tools.serviceName outputParameters: - type: object mapping: $. - name: ovh-cloud-order-and-attach description: OVH Cloud Order and attach a new vRack on your project hints: readOnly: false destructive: false idempotent: false call: ovh-cloud-cloud.post with: serviceName: tools.serviceName outputParameters: - type: object mapping: $.