openapi: 3.0.0 info: title: OVH Cloud OVHcloud API specification description: Specification for OVHcloud API version: '1.0' contact: name: OVH email: api@ml.ovh.net servers: - url: https://api.us.ovhcloud.com/v1 components: schemas: cloud.AccessTypeEnum: type: string description: Possible values for project access type enum: - full - restricted cloud.AvailableRegion: type: object description: Details about an available region that can be activated on your project properties: continentCode: allOf: - "$ref": "#/components/schemas/cloud.RegionContinentEnum" description: Region continent code readOnly: true datacenterLocation: type: string description: Location of the datacenter where the region is readOnly: true name: type: string description: Region name readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.RegionTypeEnum" description: Region type readOnly: true cloud.Backup: type: object description: List your automated backups properties: backupName: type: string description: Backup name readOnly: true createdAt: type: string description: Creation date of the workflow format: date-time readOnly: true cron: type: string description: Workflow cron pattern readOnly: true executions: type: array description: Executions logs nullable: true items: "$ref": "#/components/schemas/cloud.Execution" readOnly: true id: type: string description: Workflow id readOnly: true instanceId: type: string description: Instance id readOnly: true name: type: string description: Workflow name identifier readOnly: true cloud.Component: type: object description: Information about the different components available in the region properties: endpoint: type: string description: Endpoint URL readOnly: true name: type: string description: Service name readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.ServiceStatusEnum" description: Service status readOnly: true cloud.Execution: type: object description: An execution of the backup workflow properties: executedAt: type: string description: Last date of cron trigger execution format: date-time readOnly: true id: type: string description: Execution ID readOnly: true state: allOf: - "$ref": "#/components/schemas/cloud.ExecutionStateEnum" description: Execution state readOnly: true stateInfo: type: string description: Information about state readOnly: true cloud.ExecutionStateEnum: type: string description: Enum values for State enum: - CANCELED - ERROR - IDLE - PAUSED - RUNNING - SUCCESS cloud.IpCountryEnum: type: string description: Enum values for IpCountry enum: - au - be - ca - cz - de - es - fi - fr - ie - it - lt - nl - pl - pt - sg - uk - us cloud.Lab: type: object description: A public cloud lab permits to activate a feature in beta properties: id: type: string description: Lab ID readOnly: true name: type: string description: Lab name readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.LabStatusEnum" description: Lab status readOnly: true cloud.LabAgreements: type: object description: List of required agreements to activate the lab properties: accepted: type: array description: List of agreements already accepted to activate the lab items: type: integer readOnly: true toAccept: type: array description: List of agreements to accept before activate the lab items: type: integer readOnly: true cloud.LabStatusEnum: type: string description: Enum values for Status enum: - activated - activating - closed - open cloud.Operation: type: object description: An operation is an async process on your Project properties: action: type: string description: The action of the operation readOnly: true completedAt: type: string description: The completed date of the operation nullable: true format: date-time readOnly: true createdAt: type: string description: The creation date of the operation format: date-time readOnly: true id: type: string description: Unique ID to describe the operation readOnly: true progress: type: integer description: The progression in percentage of the operation readOnly: true regions: type: array description: Affected regions of the operation nullable: true items: type: string readOnly: true resourceId: type: string description: Affected resource of the operation nullable: true readOnly: true startedAt: type: string description: The started date of the operation nullable: true format: date-time readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.OperationStatusEnum" description: Operation status readOnly: true subOperations: type: array description: Sub-operations of the operation nullable: true items: "$ref": "#/components/schemas/cloud.SubOperation" readOnly: true cloud.OperationStatusEnum: type: string description: Enum values for Status enum: - completed - created - in-error - in-progress - unknown cloud.Project: type: object description: Project properties: access: allOf: - "$ref": "#/components/schemas/cloud.AccessTypeEnum" description: Project access readOnly: true creationDate: type: string description: Project creation date format: date-time readOnly: true description: type: string description: Description of your project nullable: true expiration: type: string description: Expiration date of your project. After this date, your project will be deleted nullable: true format: date-time readOnly: true manualQuota: type: boolean description: Manual quota prevent automatic quota upgrade orderId: type: integer description: Project order id nullable: true readOnly: true planCode: type: string description: Order plan code readOnly: true projectName: type: string description: Project name nullable: true readOnly: true project_id: type: string description: Project id readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.ProjectStatusEnum" description: Current status readOnly: true unleash: type: boolean description: Project unleashed readOnly: true cloud.ProjectActivateMonthlyBillingCreation: type: object description: Missing description properties: instances: type: array description: Instance ids and regions items: "$ref": "#/components/schemas/cloud.instance.MonthlyInstanceBulkParams" required: - instances cloud.ProjectContainerRegistryCreation: type: object description: Missing description properties: name: type: string description: Name of the new registry planID: type: string description: ID of the plan to use for the new registry region: type: string description: Region where to deploy the registry. Get available regions with /cloud/project/{serviceName}/capabilities/containerRegistry. required: - name - region cloud.ProjectContainerRegistryUpdate: type: object description: Missing description properties: name: type: string description: New registry name required: - name cloud.ProjectContainerRegistryUsersCreation: type: object description: Missing description properties: email: type: string description: New user email nullable: true login: type: string description: New user login nullable: true cloud.ProjectInstanceBulkCreation: type: object description: Missing description properties: autobackup: allOf: - "$ref": "#/components/schemas/cloud.instance.AutoBackup" description: Create an autobackup workflow after instance start up nullable: true flavorId: type: string description: Instance flavor id groupId: type: string description: Start instance in group nullable: true imageId: type: string description: Instance image id nullable: true monthlyBilling: type: boolean description: Active monthly billing nullable: true name: type: string description: Instance name networks: type: array description: Create network interfaces nullable: true items: "$ref": "#/components/schemas/cloud.instance.NetworkBulkParams" number: type: integer description: Number of instances you want to create region: type: string description: Instance region sshKeyId: type: string description: SSH keypair id nullable: true userData: type: string description: Configuration information or scripts to use upon launch nullable: true volumeId: type: string description: Specify a volume id to boot from it nullable: true required: - flavorId - name - number - region cloud.ProjectInstanceCreation: type: object description: Missing description properties: autobackup: allOf: - "$ref": "#/components/schemas/cloud.instance.AutoBackup" description: Create an autobackup workflow after instance start up nullable: true flavorId: type: string description: Instance flavor id groupId: type: string description: Start instance in group nullable: true imageId: type: string description: Instance image id nullable: true monthlyBilling: type: boolean description: Active monthly billing nullable: true name: type: string description: Instance name networks: type: array description: Create network interfaces nullable: true items: "$ref": "#/components/schemas/cloud.instance.NetworkParams" region: type: string description: Instance region sshKeyId: type: string description: SSH keypair id nullable: true userData: type: string description: Configuration information or scripts to use upon launch nullable: true volumeId: type: string description: Specify a volume id to boot from it nullable: true required: - flavorId - name - region cloud.ProjectInstanceGroupCreation: type: object description: Missing description properties: name: type: string description: instance group name region: type: string description: Instance region type: description: Instance group type "$ref": "#/components/schemas/cloud.instancegroup.InstanceGroupTypeEnum" required: - name - region - type cloud.ProjectInstanceInterfaceCreation: type: object description: Missing description properties: ip: allOf: - "$ref": "#/components/schemas/ip" description: Static ip (Can only be defined for private networks) nullable: true networkId: type: string description: Network id required: - networkId cloud.ProjectInstanceRebootCreation: type: object description: Missing description properties: type: description: Reboot type (default soft) "$ref": "#/components/schemas/cloud.instance.RebootTypeEnum" required: - type cloud.ProjectInstanceReinstallCreation: type: object description: Missing description properties: imageId: type: string description: Image to reinstall required: - imageId cloud.ProjectInstanceRescueModeCreation: type: object description: Missing description properties: imageId: type: string description: Image to boot on nullable: true rescue: type: boolean description: Enable rescue mode required: - rescue cloud.ProjectInstanceResizeCreation: type: object description: Missing description properties: flavorId: type: string description: Flavor id required: - flavorId cloud.ProjectInstanceSnapshotCreation: type: object description: Missing description properties: snapshotName: type: string description: Snapshot name required: - snapshotName cloud.ProjectInstanceUpdate: type: object description: Missing description properties: instanceName: type: string description: Instance new name required: - instanceName cloud.ProjectIpFailoverAttachCreation: type: object description: Missing description properties: instanceId: type: string description: Attach failover ip to instance required: - instanceId cloud.ProjectKubeCreation: type: object description: Missing description properties: customization: allOf: - "$ref": "#/components/schemas/cloud.ProjectKubeCustomization" description: Kubernetes cluster customization nullable: true kubeProxyMode: description: Selected mode for kube-proxy "$ref": "#/components/schemas/cloud.kube.KubeProxyModeEnum" loadBalancersSubnetId: type: string description: OpenStack subnet ID that the load balancers will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId and nodesSubnetId are also set format: uuid name: type: string description: Kubernetes cluster name nodepool: description: Nodepool to initialize with cluster creation "$ref": "#/components/schemas/cloud.ProjectKubeCreationNodePool" nodesSubnetId: type: string description: OpenStack subnet ID that the cluster nodes will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId is also set. If unspecified, it will be selected automatically when the first node is created. privateNetworkConfiguration: description: The private network configuration. "$ref": "#/components/schemas/cloud.kube.PrivateNetworkConfiguration" privateNetworkId: type: string description: OpenStack private network ID that the cluster will use. Optional, can only be set on cluster creation or reset. If unspecified, the cluster will use the public network. region: type: string description: Kubernetes OpenStack region updatePolicy: allOf: - "$ref": "#/components/schemas/cloud.kube.UpdatePolicyEnum" description: Enum values for UpdatePolicy nullable: true version: description: Kubernetes version to install "$ref": "#/components/schemas/cloud.kube.VersionEnum" required: - region cloud.ProjectKubeCreationNodePool: type: object description: Missing description properties: antiAffinity: type: boolean description: Enable anti affinity groups for nodes in the pool nullable: true autoscale: type: boolean description: Enable the auto-scaling on the pool nullable: true desiredNodes: type: integer description: Number of nodes to instantiate (1 by default) flavorName: type: string description: Nodes flavor maxNodes: type: integer description: Higher limit you accept for the desiredNodes value (100 by default) minNodes: type: integer description: Lower limit you accept for the desiredNodes value (0 by default) monthlyBilled: type: boolean description: Enable monthly billing for nodes in the pool nullable: true name: type: string description: NodePool name template: description: NodePool template to apply to each children nodes "$ref": "#/components/schemas/cloud.kube.NodePoolTemplate" cloud.ProjectKubeCustomization: type: object description: Cluster customization properties: apiServer: allOf: - "$ref": "#/components/schemas/cloud.ProjectKubeCustomizationAPIServer" description: Kubernetes cluster api server customization nullable: true kubeProxy: allOf: - "$ref": "#/components/schemas/cloud.ProjectKubeCustomizationKubeProxy" description: Kubernetes cluster kube-proxy customization nullable: true cloud.ProjectKubeCustomizationAPIServer: type: object description: Cluster API server customization properties: admissionPlugins: allOf: - "$ref": "#/components/schemas/cloud.ProjectKubeCustomizationAPIServerAdmissionPlugins" description: Kubernetes cluster api server admission plugins customization nullable: true cloud.ProjectKubeCustomizationAPIServerAdmissionPlugins: type: object description: Cluster API server admission plugins customization properties: disabled: type: array description: Array of disabled admission plugins nullable: true items: "$ref": "#/components/schemas/cloud.ProjectKubeCustomizationAPIServerAdmissionPluginsEnum" enabled: type: array description: Array of enabled admission plugins nullable: true items: "$ref": "#/components/schemas/cloud.ProjectKubeCustomizationAPIServerAdmissionPluginsEnum" cloud.ProjectKubeCustomizationAPIServerAdmissionPluginsEnum: type: string description: Enum admission plugins enum: - AlwaysPullImages - NodeRestriction cloud.ProjectKubeCustomizationKubeProxy: type: object description: 'Cluster kube-proxy customization: iptables and ipvs configurations can both be set at the same time, kube-proxy will use the one according to the cluster''s kubeProxyMode value' properties: iptables: allOf: - "$ref": "#/components/schemas/cloud.ProjectKubeCustomizationKubeProxyIptables" description: Kubernetes cluster kube-proxy customization of iptables specific config (durations format is RFC3339 duration, e.g. 'PT60S') nullable: true ipvs: allOf: - "$ref": "#/components/schemas/cloud.ProjectKubeCustomizationKubeProxyIpvs" description: Kubernetes cluster kube-proxy customization of ipvs specific config (durations format is RFC3339 duration, e.g. 'PT60S') nullable: true cloud.ProjectKubeCustomizationKubeProxyIptables: type: object description: Configuration used when kube-proxy is configured with iptables mode (durations format is RFC3339 duration, e.g. 'PT60S') properties: minSyncPeriod: type: string description: minSyncPeriod is the minimum period that iptables rules are refreshed, in RFC3339 duration format (e.g. 'PT60S') nullable: true format: duration syncPeriod: type: string description: syncPeriod is the period that iptables rules are refreshed, in RFC3339 duration format (e.g. 'PT60S'). Must be greater than 0 nullable: true format: duration cloud.ProjectKubeCustomizationKubeProxyIpvs: type: object description: Configuration used when kube-proxy is configured with ipvs mode (durations format is RFC3339 duration, e.g. 'PT60S') properties: minSyncPeriod: type: string description: minSyncPeriod is the minimum period that ipvs rules are refreshed in RFC3339 duration format (e.g. 'PT60S') nullable: true format: duration scheduler: allOf: - "$ref": "#/components/schemas/cloud.kube.KubeProxyIpvsSchedulerEnum" description: ipvs scheduler nullable: true syncPeriod: type: string description: syncPeriod is the period that ipvs rules are refreshed in RFC3339 duration format (e.g. 'PT60S'). Must be greater than 0 nullable: true format: duration tcpFinTimeout: type: string description: tcpFinTimeout is the timeout value used for IPVS TCP sessions after receiving a FIN in RFC3339 duration format (e.g. 'PT60S'). The default value is 'PT0S', which preserves the current timeout value on the system nullable: true format: duration tcpTimeout: type: string description: tcpTimeout is the timeout value used for idle IPVS TCP sessions in RFC3339 duration format (e.g. 'PT60S'). The default value is 'PT0S', which preserves the current timeout value on the system. Cannot be set between 'PT0S' and 'PT5S', in order to prevent in-cluster networking issues. nullable: true format: duration udpTimeout: type: string description: udpTimeout is the timeout value used for IPVS UDP packets in RFC3339 duration format (e.g. 'PT60S'). The default value is 'PT0S', which preserves the current timeout value on the system nullable: true format: duration cloud.ProjectKubeIpRestrictionUpsert: type: object description: Missing description properties: ips: type: array description: List of ips to add to the cluster api-server restrictions (format with /subnet available) items: "$ref": "#/components/schemas/ipBlock" cloud.ProjectKubeNodePoolAutoscalingParams: type: object description: Missing description properties: scaleDownUnneededTimeSeconds: type: integer description: How long a node should be unneeded before it is eligible for scale down scaleDownUnreadyTimeSeconds: type: integer description: How long an unready node should be unneeded before it is eligible for scale down scaleDownUtilizationThreshold: type: number description: Sum of cpu or memory of all pods running on the node divided by node's corresponding allocatable resource, below which a node can be considered for scale down cloud.ProjectKubeNodePoolCreation: type: object description: Missing description properties: antiAffinity: type: boolean description: Enable anti affinity groups for nodes in the pool nullable: true autoscale: type: boolean description: Enable the auto-scaling on the pool nullable: true autoscaling: description: Autoscaling customization parameters "$ref": "#/components/schemas/cloud.ProjectKubeNodePoolAutoscalingParams" desiredNodes: type: integer description: Number of nodes to instantiate (1 by default) flavorName: type: string description: Nodes flavor maxNodes: type: integer description: Higher limit you accept for the desiredNodes value (100 by default) minNodes: type: integer description: Lower limit you accept for the desiredNodes value (0 by default) monthlyBilled: type: boolean description: Enable monthly billing for nodes in the pool nullable: true name: type: string description: NodePool name template: description: NodePool template to apply to each children nodes "$ref": "#/components/schemas/cloud.kube.NodePoolTemplate" required: - flavorName cloud.ProjectKubeNodePoolUpdate: type: object description: Missing description properties: autoscale: type: boolean description: Enable the auto-scaling on the pool nullable: true autoscaling: description: Autoscaling customization parameters "$ref": "#/components/schemas/cloud.ProjectKubeNodePoolAutoscalingParams" desiredNodes: type: integer description: New number of nodes wanted in the nodepool maxNodes: type: integer description: New maximal number of nodes wanted in the nodepool minNodes: type: integer description: New minimal number of nodes wanted in the nodepool nodesToRemove: type: array description: List of specific node IDs, openstack instance IDs or Node.Spec.providerIDs to delete during downscale items: type: string template: description: NodePool template to apply to each children nodes "$ref": "#/components/schemas/cloud.kube.NodePoolTemplate" cloud.ProjectKubeOpenIdConnectCreation: type: object description: Creation model for OIDC properties: caContent: type: string description: Content of the certificate for the CA, in base64 format, that signed your identity provider's web certificate. Defaults to the host's root CAs. nullable: true clientId: type: string description: Client ID groupsClaim: type: array description: JWT claim to use as the user's group. If the claim is present it must be an array of strings. nullable: true items: type: string groupsPrefix: type: string description: 'Prefix prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra.' nullable: true issuerUrl: type: string description: Issuer URL requiredClaim: type: array description: key=value pairs that describe required claims in the ID Token. If set, the claims are verified to be present in the ID Token with a matching value. nullable: true items: type: string signingAlgorithms: type: array description: The signing algorithms accepted. Default is "RS256". nullable: true items: "$ref": "#/components/schemas/cloud.kube.OpenIdConnectSigningAlgorithmsEnum" usernameClaim: type: string description: JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins. nullable: true usernamePrefix: type: string description: 'Prefix prepended to username claims to prevent clashes with existing names (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. If this field isn''t set and oidcUsernameClaim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of oidcIssuerUrl. The value - can be used to disable all prefixing.' nullable: true required: - clientId - issuerUrl cloud.ProjectKubeOpenIdConnectUpdate: type: object description: Update model for OIDC properties: caContent: type: string description: Content of the certificate for the CA, in base64 format, that signed your identity provider's web certificate. Defaults to the host's root CAs. nullable: true clientId: type: string description: Client ID groupsClaim: type: array description: JWT claim to use as the user's group. If the claim is present it must be an array of strings. nullable: true items: type: string groupsPrefix: type: string description: 'Prefix prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra.' nullable: true issuerUrl: type: string description: Issuer URL requiredClaim: type: array description: key=value pairs that describe required claims in the ID Token. If set, the claims are verified to be present in the ID Token with a matching value. nullable: true items: type: string signingAlgorithms: type: array description: The signing algorithms accepted. Default is "RS256". nullable: true items: "$ref": "#/components/schemas/cloud.kube.OpenIdConnectSigningAlgorithmsEnum" usernameClaim: type: string description: JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins. nullable: true usernamePrefix: type: string description: 'Prefix prepended to username claims to prevent clashes with existing names (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. If this field isn''t set and oidcUsernameClaim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of oidcIssuerUrl. The value - can be used to disable all prefixing.' nullable: true cloud.ProjectKubeResetCreation: type: object description: Model object to reset kube cluster properties: customization: description: Kubernetes cluster customization "$ref": "#/components/schemas/cloud.ProjectKubeCustomization" kubeProxyMode: description: Selected mode for kube-proxy "$ref": "#/components/schemas/cloud.kube.KubeProxyModeEnum" loadBalancersSubnetId: type: string description: OpenStack subnet ID that the load balancers will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId and nodesSubnetId are also set format: uuid name: type: string description: New cluster name nodesSubnetId: type: string description: OpenStack subnet ID that the cluster nodes will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId is also set. If unspecified, it will be selected automatically when the first node is created. privateNetworkConfiguration: description: The private network configuration. "$ref": "#/components/schemas/cloud.kube.PrivateNetworkConfiguration" privateNetworkId: type: string description: OpenStack private network ID that the cluster will use. Optional, can only be set on cluster creation or reset. If unspecified, the cluster will use the public network. updatePolicy: description: Enum values for UpdatePolicy "$ref": "#/components/schemas/cloud.kube.UpdatePolicyEnum" version: description: Kubernetes version to use after reset, by default it keeps the current version "$ref": "#/components/schemas/cloud.kube.VersionEnum" workerNodesPolicy: description: Worker nodes reset policy, default is delete "$ref": "#/components/schemas/cloud.kube.ResetWorkerNodesPolicyEnum" cloud.ProjectKubeRestart: type: object description: Missing description properties: force: type: boolean description: Force restarting control plane apiserver (will create a slight downtime) nullable: true cloud.ProjectKubeUpdate: type: object description: Missing description properties: name: type: string description: Cluster new name updatePolicy: description: Enum values for UpdatePolicy "$ref": "#/components/schemas/cloud.kube.UpdatePolicyEnum" cloud.ProjectKubeUpdateCreation: type: object description: Missing description properties: force: type: boolean description: Force redeploying the control plane / reinstalling the nodes regardless of their current version nullable: true strategy: description: The update strategy to apply on your service (next patch or minor version) "$ref": "#/components/schemas/cloud.kube.UpdateStrategyEnum" cloud.ProjectKubeUpdateLoadBalancersSubnetId: type: object description: Model object to update loadBalancersSubnetId property of a kube cluster properties: loadBalancersSubnetId: type: string description: OpenStack subnet ID that the load balancers will use format: uuid required: - loadBalancersSubnetId cloud.ProjectKubeUpdatePolicyUpdate: type: object description: Missing description properties: updatePolicy: description: Update policy "$ref": "#/components/schemas/cloud.kube.UpdatePolicyEnum" required: - updatePolicy cloud.ProjectNetworkPrivateCreation: type: object description: Missing description properties: name: type: string description: Network name regions: type: array description: Region where to activate private network. No parameters means all region nullable: true items: type: string vlanId: type: integer description: Vland id, between 0 and 4000. 0 value means no vlan. nullable: true required: - name cloud.ProjectNetworkPrivateRegionCreation: type: object description: Missing description properties: region: type: string description: Region to active on your network required: - region cloud.ProjectNetworkPrivateSubnetCreation: type: object description: Missing description properties: dhcp: type: boolean description: Enable DHCP end: description: 'Last IP for this region (eg: 192.168.1.24)' "$ref": "#/components/schemas/ip" network: description: 'Global network with cidr (eg: 192.168.1.0/24)' "$ref": "#/components/schemas/ipBlock" noGateway: type: boolean description: Set to true if you don't want to set a default gateway IP region: type: string description: Region where this subnet will be created start: description: 'First IP for this region (eg: 192.168.1.12)' "$ref": "#/components/schemas/ip" required: - dhcp - end - network - noGateway - region - start cloud.ProjectNetworkPrivateSubnetUpdate: type: object description: Missing description properties: dhcp: type: boolean description: Set to true if you don't want to set a default gateway IP disableGateway: type: boolean description: Set to true if you want to disable the default gateway gatewayIp: type: string description: Gateway IP (this field is used if noGateway = false) nullable: true required: - dhcp - disableGateway cloud.ProjectNetworkPrivateUpdate: type: object description: Missing description properties: name: type: string description: name required: - name cloud.ProjectRegionCreation: type: object description: Missing description properties: region: type: string description: Region to add on your project required: - region cloud.ProjectRegionQuotaCreation: type: object description: Missing description properties: name: type: string description: Name of the new quota required: - name cloud.ProjectRegionWorkflowBackupCreation: type: object description: Missing description properties: cron: type: string description: 'Unix Cron pattern (eg: ''* * * * *'')' instanceId: type: string description: Instance ID to backup maxExecutionCount: type: integer description: Number of execution to process before ending the job. Null value means that the job will never end. nullable: true name: type: string description: Name of your backup job rotation: type: integer description: Number of backup to keep required: - cron - instanceId - name - rotation cloud.ProjectSshkeyCreation: type: object description: Missing description properties: name: type: string description: SSH key name publicKey: type: string description: SSH public key region: type: string description: Region to create SSH key nullable: true required: - name - publicKey cloud.ProjectStorageCorsCreation: type: object description: Missing description properties: origin: type: string description: Allow this origin required: - origin cloud.ProjectStorageCreation: type: object description: Missing description properties: archive: type: boolean description: Archive container flag containerName: type: string description: Container name region: type: string description: Region required: - archive - containerName - region cloud.ProjectStoragePublicUrlCreation: type: object description: Missing description properties: expirationDate: type: string description: Temporary URL expiration format: date-time objectName: type: string description: Object name required: - expirationDate - objectName cloud.ProjectStorageUpdate: type: object description: Missing description properties: containerType: allOf: - "$ref": "#/components/schemas/cloud.storage.TypeEnum" description: Container type nullable: true cloud.ProjectStorageUserCreation: type: object description: Missing description properties: description: type: string description: User description nullable: true right: description: User right (all, read, write) "$ref": "#/components/schemas/cloud.storage.RightEnum" required: - right cloud.ProjectUserCreation: type: object description: Missing description properties: description: type: string description: User description nullable: true role: allOf: - "$ref": "#/components/schemas/cloud.user.RoleEnum" description: Openstack keystone role name nullable: true roles: type: array description: Openstack keystone roles names nullable: true items: "$ref": "#/components/schemas/cloud.user.RoleEnum" cloud.ProjectUserRoleCreation: type: object description: Missing description properties: roleId: type: string description: Role id required: - roleId cloud.ProjectUserRoleUpdate: type: object description: Missing description properties: rolesIds: type: array description: Roles ids items: type: string required: - rolesIds cloud.ProjectUserTokenCreation: type: object description: Missing description properties: password: type: string description: User password format: password required: - password cloud.ProjectVolumeAttachCreation: type: object description: Missing description properties: instanceId: type: string description: Instance id required: - instanceId cloud.ProjectVolumeCreation: type: object description: Missing description properties: description: type: string description: Volume description nullable: true imageId: type: string description: Id of image to create a bootable volume nullable: true name: type: string description: Volume name nullable: true region: type: string description: Volume region size: type: integer description: Volume size (in GiB) snapshotId: type: string description: Source snapshot id nullable: true type: description: Volume type "$ref": "#/components/schemas/cloud.volume.VolumeTypeEnum" required: - region - size - type cloud.ProjectVolumeDetachCreation: type: object description: Missing description properties: instanceId: type: string description: Instance id required: - instanceId cloud.ProjectVolumeSnapshotCreation: type: object description: Missing description properties: description: type: string description: Snapshot description nullable: true name: type: string description: Snapshot name nullable: true cloud.ProjectVolumeUpdate: type: object description: Missing description properties: description: type: string description: Volume description nullable: true name: type: string description: Volume name nullable: true cloud.ProjectVolumeUpsizeCreation: type: object description: Missing description properties: size: type: integer description: New volume size (in GiB) (must be greater than current one) required: - size cloud.ProjectWithIAM: type: object description: Project properties: access: allOf: - "$ref": "#/components/schemas/cloud.AccessTypeEnum" description: Project access readOnly: true creationDate: type: string description: Project creation date format: date-time readOnly: true description: type: string description: Description of your project nullable: true expiration: type: string description: Expiration date of your project. After this date, your project will be deleted nullable: true format: date-time readOnly: true iam: allOf: - "$ref": "#/components/schemas/iam.ResourceMetadata" description: IAM resource metadata nullable: true readOnly: true manualQuota: type: boolean description: Manual quota prevent automatic quota upgrade orderId: type: integer description: Project order id nullable: true readOnly: true planCode: type: string description: Order plan code readOnly: true projectName: type: string description: Project name nullable: true readOnly: true project_id: type: string description: Project id readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.ProjectStatusEnum" description: Current status readOnly: true unleash: type: boolean description: Project unleashed readOnly: true cloud.Region: type: object description: Details about your region properties: continentCode: allOf: - "$ref": "#/components/schemas/cloud.RegionContinentEnum" description: Region continent code readOnly: true datacenterLocation: type: string description: Location of the datacenter where the region is readOnly: true ipCountries: type: array description: Allowed countries for failover ip items: "$ref": "#/components/schemas/cloud.IpCountryEnum" readOnly: true name: type: string description: Region name readOnly: true services: type: array description: Details about components status items: "$ref": "#/components/schemas/cloud.Component" readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.RegionStatusEnum" description: Openstack region status readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.RegionTypeEnum" description: Region type readOnly: true cloud.RegionContinentEnum: type: string description: Enum values for ContinentCode enum: - ASIA - EU - NA - US cloud.RegionStatusEnum: type: string description: Enum values for Status enum: - DOWN - MAINTENANCE - UP cloud.RegionTypeEnum: type: string description: Enum values for region type enum: - localzone - region cloud.ServiceStatusEnum: type: string description: Enum values for Status enum: - DOWN - UP cloud.StorageContainer: type: object description: Container properties: createdAt: type: string description: The date and timestamp when the resource was created format: date-time readOnly: true encryption: allOf: - "$ref": "#/components/schemas/cloud.StorageEncryptionObject" description: Encryption configuration nullable: true name: type: string description: Container name readOnly: true objects: type: array description: Container objects items: "$ref": "#/components/schemas/cloud.StorageObject" readOnly: true objectsCount: type: integer description: Container total objects count readOnly: true objectsSize: type: integer description: Container total objects size (bytes) readOnly: true ownerId: type: integer description: Container owner user ID readOnly: true region: type: string description: Container region readOnly: true versioning: allOf: - "$ref": "#/components/schemas/cloud.StorageVersioningObject" description: Versioning configuration nullable: true virtualHost: type: string description: Container virtual host readOnly: true cloud.StorageContainerCreation: type: object description: Create a container properties: encryption: allOf: - "$ref": "#/components/schemas/cloud.StorageEncryptionObject" description: Encryption configuration nullable: true name: type: string description: Container name ownerId: type: integer description: Container owner user ID nullable: true versioning: allOf: - "$ref": "#/components/schemas/cloud.StorageVersioningObject" description: Versioning configuration nullable: true required: - name cloud.StorageEncryptionObject: type: object description: Object properties: sseAlgorithm: allOf: - "$ref": "#/components/schemas/cloud.storage.EncryptionAlgorithmEnum" description: Encryption algorithm nullable: true cloud.StorageObject: type: object description: Object properties: etag: type: string description: ETag readOnly: true key: type: string description: Key readOnly: true lastModified: type: string description: Last modification date format: date-time readOnly: true size: type: integer description: Size (bytes) readOnly: true storageClass: allOf: - "$ref": "#/components/schemas/cloud.storage.StorageClassEnum" description: Storage class readOnly: true cloud.StorageVersioningObject: type: object description: Object properties: status: allOf: - "$ref": "#/components/schemas/cloud.storage.VersioningStatusEnum" description: Versioning status nullable: true cloud.SubOperation: type: object description: A sub-operation is a child of an operation on your Project properties: action: type: string description: The action of the sub-operation readOnly: true completedAt: type: string description: The completed date of the sub-operation nullable: true format: date-time readOnly: true id: type: string description: Unique ID to describe the sub-operation readOnly: true progress: type: integer description: The progression in percentage of the sub-operation readOnly: true regions: type: array description: Affected regions of the sub-operation nullable: true items: type: string readOnly: true resourceId: type: string description: Affected resource of the sub-operation nullable: true readOnly: true startedAt: type: string description: The started date of the sub-operation nullable: true format: date-time readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.OperationStatusEnum" description: Sub-operation status readOnly: true cloud.Vrack: type: object description: A vRack allows to connect your OVH infrastructures accross products and datacenters properties: description: type: string description: Description of your vRack readOnly: true id: type: string description: Vrack ID readOnly: true name: type: string description: Name of your vRack readOnly: true cloud.authentication.Catalog: type: object description: Catalog properties: endpoints: type: array items: "$ref": "#/components/schemas/cloud.authentication.Endpoint" readOnly: true id: type: string readOnly: true type: type: string readOnly: true cloud.authentication.Domain: type: object description: Domain properties: name: type: string readOnly: true cloud.authentication.Endpoint: type: object description: Endpoint properties: id: type: string readOnly: true interface: type: string readOnly: true legacy_endpoint_id: type: string readOnly: true region_id: type: string readOnly: true service_id: type: string readOnly: true url: type: string readOnly: true cloud.authentication.OpenstackToken: type: object description: OpenstackToken properties: catalog: type: array items: "$ref": "#/components/schemas/cloud.authentication.Catalog" readOnly: true expires_at: type: string format: date-time readOnly: true issued_at: type: string format: date-time readOnly: true methods: type: array items: type: string readOnly: true project: allOf: - "$ref": "#/components/schemas/cloud.authentication.TokenProject" readOnly: true roles: type: array items: "$ref": "#/components/schemas/cloud.authentication.Role" readOnly: true user: allOf: - "$ref": "#/components/schemas/cloud.authentication.UserToken" readOnly: true cloud.authentication.Role: type: object description: Role properties: id: type: string readOnly: true name: type: string readOnly: true cloud.authentication.Token: type: object description: Token properties: X-Auth-Token: type: string readOnly: true token: allOf: - "$ref": "#/components/schemas/cloud.authentication.OpenstackToken" readOnly: true cloud.authentication.TokenProject: type: object description: TokenProject properties: domain: allOf: - "$ref": "#/components/schemas/cloud.authentication.Domain" readOnly: true id: type: string readOnly: true name: type: string readOnly: true cloud.authentication.UserToken: type: object description: UserToken properties: domain: allOf: - "$ref": "#/components/schemas/cloud.authentication.Domain" readOnly: true id: type: string readOnly: true name: type: string readOnly: true cloud.capabilities.Availability: type: object description: Public Cloud products availability properties: plans: type: array description: Plan availability items: "$ref": "#/components/schemas/cloud.capabilities.AvailabilityPlan" readOnly: true products: type: array description: Product availability items: "$ref": "#/components/schemas/cloud.capabilities.AvailabilityProduct" readOnly: true cloud.capabilities.AvailabilityPlan: type: object description: Public Cloud plan availability properties: code: type: string description: Plan code readOnly: true regions: type: array description: Plan is available on those regions items: "$ref": "#/components/schemas/cloud.capabilities.AvailabilityRegion" readOnly: true cloud.capabilities.AvailabilityProduct: type: object description: Public Cloud product availability properties: name: type: string description: Product name readOnly: true regions: type: array description: Product is available on those regions items: "$ref": "#/components/schemas/cloud.capabilities.AvailabilityRegion" readOnly: true cloud.capabilities.AvailabilityRegion: type: object description: Details about a region properties: continentCode: allOf: - "$ref": "#/components/schemas/cloud.RegionContinentEnum" description: Region continent code readOnly: true datacenter: type: string description: Location of the datacenter where the region is readOnly: true enabled: type: boolean description: Region is enabled readOnly: true name: type: string description: Region name readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.RegionTypeEnum" description: Region type readOnly: true cloud.containerRegistry.Capability: type: object description: The container registry capability for a single region properties: plans: type: array description: Available plans in the region items: "$ref": "#/components/schemas/cloud.containerRegistry.Plan" readOnly: true regionName: type: string description: The region name readOnly: true cloud.containerRegistry.Features: type: object description: Features list, enabled or not properties: vulnerability: type: boolean description: Vulnerability scanning readOnly: true cloud.containerRegistry.IPRestrictions: type: object description: Container registry Get IP Restrictions properties: createdAt: type: string description: IP Restrictions creation date format: date-time readOnly: true description: type: string description: The Description of Whitelisted IpBlock ipBlock: description: Whitelisted IpBlock "$ref": "#/components/schemas/ipBlock" updatedAt: type: string description: IP Restrictions update date format: date-time readOnly: true cloud.containerRegistry.Limits: type: object description: Limitation of a docker registry properties: imageStorage: type: integer description: Docker image storage limits in bytes readOnly: true parallelRequest: type: integer description: Parallel requests on Docker image API (/v2 Docker registry API) readOnly: true cloud.containerRegistry.OIDCConfiguration: type: object description: Docker registry OIDC Configuration properties: adminGroup: type: string description: The OIDC Configuration AdminGroup nullable: true autoOnboard: type: boolean description: The OIDC Configuration AutoOnboard nullable: true clientId: type: string description: The OIDC Configuration ClientID clientSecret: type: string description: The OIDC Configuration Client Secret nullable: true format: password createdAt: type: string description: The OIDC Configuration creation date format: date-time readOnly: true endpoint: type: string description: The OIDC Configuration Endpoint groupsClaim: type: string description: The OIDC Configuration GroupsClaim nullable: true id: type: string description: The OIDC Configuration ID readOnly: true name: type: string description: The OIDC Configuration Name scope: type: string description: The OIDC Configuration comma-separated list of Scopes status: allOf: - "$ref": "#/components/schemas/cloud.containerRegistry.OIDCStatusEnum" description: The OIDC Configuration status readOnly: true updatedAt: type: string description: The OIDC Configuration last update date nullable: true format: date-time readOnly: true userClaim: type: string description: The OIDC Configuration UserClaim nullable: true verifyCert: type: boolean description: The OIDC Configuration VerifyCert nullable: true required: - clientId - clientSecret - endpoint - name - scope cloud.containerRegistry.OIDCPost: type: object description: Docker registry Post OIDC configuration properties: deleteUsers: type: boolean description: Delete all previously created users to allow OIDC configuration nullable: true provider: description: The OIDC provider configuration "$ref": "#/components/schemas/cloud.containerRegistry.OIDCConfiguration" required: - provider cloud.containerRegistry.OIDCPut: type: object description: Docker registry Put OIDC Configuration properties: adminGroup: type: string description: The OIDC Configuration AdminGroup nullable: true autoOnboard: type: boolean description: The OIDC Configuration AutoOnboard nullable: true clientId: type: string description: The OIDC Configuration ClientID nullable: true clientSecret: type: string description: The OIDC Configuration Client Secret nullable: true format: password endpoint: type: string description: The OIDC Configuration Endpoint nullable: true groupsClaim: type: string description: The OIDC Configuration GroupsClaim nullable: true name: type: string description: The OIDC Configuration Name nullable: true scope: type: string description: The OIDC Configuration comma-separated list of Scopes nullable: true userClaim: type: string description: The OIDC Configuration UserClaim nullable: true verifyCert: type: boolean description: The OIDC Configuration VerifyCert nullable: true cloud.containerRegistry.OIDCStatusEnum: type: string description: Status of the registry's oidc configuration enum: - DELETING - ERROR - INSTALLING - PATCHING - READY - UPDATING cloud.containerRegistry.Plan: type: object description: Plan of the registry properties: code: type: string description: Plan code from catalog readOnly: true createdAt: type: string description: Plan creation date format: date-time readOnly: true features: allOf: - "$ref": "#/components/schemas/cloud.containerRegistry.Features" description: Features of the plan readOnly: true id: type: string description: Plan ID readOnly: true name: type: string description: Plan name readOnly: true registryLimits: allOf: - "$ref": "#/components/schemas/cloud.containerRegistry.Limits" description: Container registry limits readOnly: true updatedAt: type: string description: Plan last update date format: date-time readOnly: true cloud.containerRegistry.PlanUpdate: type: object description: Missing description properties: planID: type: string description: Plan ID to apply to the registry required: - planID cloud.containerRegistry.Registry: type: object description: Managed docker registry properties: createdAt: type: string description: Registry creation date format: date-time readOnly: true id: type: string description: Registry ID readOnly: true name: type: string description: Registry name readOnly: true projectID: type: string description: Project ID of your registry readOnly: true region: type: string description: Region of the registry. readOnly: true size: type: integer description: Current size of the registry (bytes) readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.containerRegistry.StatusEnum" description: Registry status readOnly: true updatedAt: type: string description: Registry last update date format: date-time readOnly: true url: type: string description: Access url of the registry readOnly: true version: type: string description: Version of your registry readOnly: true cloud.containerRegistry.StatusEnum: type: string description: Status of the registry enum: - DELETED - DELETING - ERROR - INSTALLING - READY - RESTORING - SUSPENDED - SUSPENDING - UPDATING cloud.containerRegistry.User: type: object description: Docker registry user properties: email: type: string description: User email readOnly: true id: type: string description: User ID readOnly: true password: type: string description: User password nullable: true format: password readOnly: true user: type: string description: User name readOnly: true cloud.flavor.Capability: type: object description: Flavor capability properties: enabled: type: boolean description: Is the capability enabled readOnly: true name: allOf: - "$ref": "#/components/schemas/cloud.flavor.CapabilityNameEnum" description: Name of the capability readOnly: true cloud.flavor.CapabilityNameEnum: type: string description: Enum values for flavor capabilities names enum: - failoverip - resize - snapshot - volume cloud.flavor.Flavor: type: object description: Flavor properties: available: type: boolean description: Available in stock readOnly: true capabilities: type: array description: Capabilities of the flavor items: "$ref": "#/components/schemas/cloud.flavor.Capability" readOnly: true disk: type: integer description: Number of disks readOnly: true id: type: string description: Flavor id readOnly: true inboundBandwidth: type: integer description: Max capacity of inbound traffic in Mbit/s nullable: true readOnly: true name: type: string description: Flavor name readOnly: true osType: type: string description: OS to install on readOnly: true outboundBandwidth: type: integer description: Max capacity of outbound traffic in Mbit/s nullable: true readOnly: true planCodes: allOf: - "$ref": "#/components/schemas/cloud.flavor.FlavorPlanCodes" description: Plan codes to order instances readOnly: true quota: type: integer description: Number instance you can spawn with your actual quota readOnly: true ram: type: integer description: Ram quantity (Gio) readOnly: true region: type: string description: Flavor region readOnly: true type: type: string description: Flavor type readOnly: true vcpus: type: integer description: Number of VCPUs readOnly: true cloud.flavor.FlavorPlanCodes: type: object description: FlavorPlanCodes properties: hourly: type: string description: Plan code to order hourly instance nullable: true readOnly: true monthly: type: string description: Plan code to order monthly instance nullable: true readOnly: true cloud.image.Image: type: object description: Image properties: creationDate: type: string description: Image creation date format: date-time readOnly: true flavorType: type: string description: Image usable only for this type of flavor if not null nullable: true readOnly: true id: type: string description: Image id readOnly: true minDisk: type: integer description: Minimum disks required to use image readOnly: true minRam: type: integer description: Minimum RAM required to use image readOnly: true name: type: string description: Image name readOnly: true planCode: type: string description: Order plan code nullable: true readOnly: true region: type: string description: Image region readOnly: true size: type: number description: Image size (in GiB) readOnly: true status: type: string description: Image status readOnly: true tags: type: array description: Tags about the image nullable: true items: type: string readOnly: true type: type: string description: Image type readOnly: true user: type: string description: User to connect with readOnly: true visibility: type: string description: Image visibility readOnly: true cloud.image.OSTypeEnum: type: string description: OSTypeEnum enum: - baremetal-linux - bsd - linux - windows cloud.instance.Access: type: object description: Access properties: login: type: string description: Login readOnly: true password: type: string description: Password format: password readOnly: true type: type: string description: Application access type readOnly: true url: type: string description: Url readOnly: true cloud.instance.ApplicationAccess: type: object description: ApplicationAccess properties: accesses: type: array description: List of credentials items: "$ref": "#/components/schemas/cloud.instance.Access" readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.instance.ApplicationAccessStateEnum" description: Application status readOnly: true cloud.instance.ApplicationAccessStateEnum: type: string description: ApplicationAccessStateEnum enum: - installing - ok cloud.instance.AssociateFloatingIp: type: object description: Parameters to associate an existing floating IP to an instance properties: floatingIpId: type: string description: Floating IP ID format: uuid gateway: allOf: - "$ref": "#/components/schemas/cloud.network.CreateGatewaySummary" description: Parameters to create a gateway if required nullable: true ip: description: Private instance IP to associate the floating IP with "$ref": "#/components/schemas/ip" required: - floatingIpId - ip cloud.instance.AutoBackup: type: object description: Autobackup params at instance creation properties: cron: type: string description: 'Unix Cron pattern (eg: ''0 0 * * *'')' rotation: type: integer description: Number of backup to keep cloud.instance.CreateFloatingIp: type: object description: Parameters to create a floating IP for an instance properties: gateway: allOf: - "$ref": "#/components/schemas/cloud.network.CreateGatewaySummary" description: Parameters to create a gateway if required nullable: true ip: description: Private instance IP to associate the floating IP with "$ref": "#/components/schemas/ip" required: - ip cloud.instance.CreateInput: type: object description: Instance creation input properties: autobackup: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.Autobackup" description: Create an autobackup workflow after instance start up nullable: true billingPeriod: description: Billing period "$ref": "#/components/schemas/cloud.instance.CreateInput.BillingPeriodEnum" bootFrom: description: Boot the instance from an image or a volume "$ref": "#/components/schemas/cloud.instance.CreateInput.BootFrom" bulk: type: integer description: Create multiple instances flavor: description: Flavor information "$ref": "#/components/schemas/cloud.instance.CreateInput.Flavor" group: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.Group" description: Start instance in group nullable: true name: type: string description: Instance name network: description: Networks information "$ref": "#/components/schemas/cloud.instance.CreateInput.Network" sshKey: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.SshKey" description: Existing SSH Keypair nullable: true sshKeyCreate: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.SshKeyCreate" description: Information to create a new SSH Keypair nullable: true userData: type: string description: Configuration information or scripts to use upon launch nullable: true cloud.instance.CreateInput.Autobackup: type: object description: Create an autobackup workflow after instance start up properties: cron: type: string description: 'Unix Cron pattern (eg: ''0 0 * * *'')' rotation: type: integer description: Number of backup to keep cloud.instance.CreateInput.BillingPeriodEnum: type: string description: Billing period enum: - hourly - monthly cloud.instance.CreateInput.BootFrom: type: object description: Boot the instance from an image or a volume properties: imageId: type: string description: Instance image id nullable: true format: uuid volumeId: type: string description: Specify a volume id to boot from it nullable: true format: uuid cloud.instance.CreateInput.Flavor: type: object description: Flavor information properties: id: type: string description: Instance flavor id format: uuid cloud.instance.CreateInput.Group: type: object description: Start instance in group properties: id: type: string description: Group id cloud.instance.CreateInput.Network: type: object description: Networks information properties: private: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.Network.Private" description: Private network information nullable: true public: type: boolean description: Set the new instance as public cloud.instance.CreateInput.Network.Private: type: object description: Private network information properties: floatingIp: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.Network.Private.FloatingIp" description: Existing floating IP nullable: true floatingIpCreate: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.Network.Private.FloatingIpCreate" description: Information to create a new floating IP nullable: true gateway: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.Network.Private.Gateway" description: Existing gateway nullable: true gatewayCreate: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.Network.Private.GatewayCreate" description: Information to create a new gateway nullable: true ip: allOf: - "$ref": "#/components/schemas/ipv4" description: Instance IP in the private network nullable: true network: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.Network.Private.Network" description: Existing private network nullable: true networkCreate: allOf: - "$ref": "#/components/schemas/cloud.instance.CreateInput.Network.Private.NetworkCreate" description: Information to create a new private network nullable: true cloud.instance.CreateInput.Network.Private.FloatingIp: type: object description: Existing floating IP properties: id: type: string description: Floating IP ID format: uuid cloud.instance.CreateInput.Network.Private.FloatingIpCreate: type: object description: Information to create a new floating IP properties: description: type: string description: Floating IP description cloud.instance.CreateInput.Network.Private.Gateway: type: object description: Existing gateway properties: id: type: string description: Gateway ID format: uuid cloud.instance.CreateInput.Network.Private.GatewayCreate: type: object description: Information to create a new gateway properties: model: description: Gateway model "$ref": "#/components/schemas/cloud.instance.CreateInput.Network.Private.GatewayCreate.ModelEnum" name: type: string description: Gateway name cloud.instance.CreateInput.Network.Private.GatewayCreate.ModelEnum: type: string description: Gateway model enum: - l - m - s cloud.instance.CreateInput.Network.Private.Network: type: object description: Existing private network properties: id: type: string description: Network ID format: uuid subnetId: type: string description: Existing Subnet ID format: uuid cloud.instance.CreateInput.Network.Private.NetworkCreate: type: object description: Information to create a new private network properties: name: type: string description: Network name subnet: description: New subnet information "$ref": "#/components/schemas/cloud.instance.CreateInput.Network.Private.NetworkCreate.Subnet" vlanId: type: integer description: Network vlan ID nullable: true cloud.instance.CreateInput.Network.Private.NetworkCreate.Subnet: type: object description: New subnet information properties: cidr: description: Subnet range in CIDR notation "$ref": "#/components/schemas/ipv4Block" enableDhcp: type: boolean ipVersion: type: integer description: IP version cloud.instance.CreateInput.SshKey: type: object description: Existing SSH Keypair properties: name: type: string description: SSH Keypair name cloud.instance.CreateInput.SshKeyCreate: type: object description: Information to create a new SSH Keypair properties: name: type: string description: SSH key name publicKey: type: string description: SSH public key cloud.instance.Instance: type: object description: Instance properties: created: type: string description: Instance creation date format: date-time readOnly: true currentMonthOutgoingTraffic: type: integer description: Instance outgoing network traffic for the current month (in bytes) nullable: true readOnly: true flavorId: type: string description: Instance flavor id readOnly: true id: type: string description: Instance id readOnly: true imageId: type: string description: Instance image id readOnly: true ipAddresses: type: array description: Instance IP addresses items: "$ref": "#/components/schemas/cloud.instance.IpAddress" readOnly: true monthlyBilling: allOf: - "$ref": "#/components/schemas/cloud.instance.MonthlyBilling" description: Instance monthly billing status nullable: true readOnly: true name: type: string description: Instance name readOnly: true operationIds: type: array description: Ids of pending public cloud operations items: type: string readOnly: true planCode: type: string description: Order plan code nullable: true readOnly: true region: type: string description: Instance id readOnly: true sshKeyId: type: string description: Instance ssh key id nullable: true readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.instance.InstanceStatusEnum" description: Instance status readOnly: true cloud.instance.InstanceAddress: type: object description: IP address properties: ip: allOf: - "$ref": "#/components/schemas/ip" description: IP address readOnly: true version: type: integer description: IP version readOnly: true cloud.instance.InstanceDetail: type: object description: InstanceDetail properties: created: type: string description: Instance creation date format: date-time readOnly: true currentMonthOutgoingTraffic: type: integer description: Instance outgoing network traffic for the current month (in bytes) nullable: true readOnly: true flavor: allOf: - "$ref": "#/components/schemas/cloud.flavor.Flavor" description: Instance flavor readOnly: true id: type: string description: Instance id readOnly: true image: allOf: - "$ref": "#/components/schemas/cloud.image.Image" description: Instance image readOnly: true ipAddresses: type: array description: Instance IP addresses items: "$ref": "#/components/schemas/cloud.instance.IpAddress" readOnly: true monthlyBilling: allOf: - "$ref": "#/components/schemas/cloud.instance.MonthlyBilling" description: Instance monthly billing status nullable: true readOnly: true name: type: string description: Instance name readOnly: true operationIds: type: array description: Ids of pending public cloud operations items: type: string readOnly: true planCode: type: string description: Order plan code nullable: true readOnly: true region: type: string description: Instance id readOnly: true rescuePassword: type: string description: Rescue password if instance is in RESCUE status nullable: true format: password readOnly: true sshKey: allOf: - "$ref": "#/components/schemas/cloud.sshkey.SshKeyDetail" description: Instance SSH key nullable: true readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.instance.InstanceStatusEnum" description: Instance status readOnly: true cloud.instance.InstanceMetrics: type: object description: InstanceMetrics properties: unit: type: string readOnly: true values: type: array items: "$ref": "#/components/schemas/cloud.instance.InstanceMetricsValue" readOnly: true cloud.instance.InstanceMetricsValue: type: object description: InstanceMetricsValue properties: timestamp: type: integer readOnly: true value: type: number readOnly: true cloud.instance.InstanceStatusEnum: type: string description: InstanceStatusEnum enum: - ACTIVE - BUILD - BUILDING - DELETED - DELETING - ERROR - HARD_REBOOT - MIGRATING - PASSWORD - PAUSED - REBOOT - REBUILD - RESCUE - RESCUED - RESCUING - RESIZE - RESIZED - RESUMING - REVERT_RESIZE - SHELVED - SHELVED_OFFLOADED - SHELVING - SHUTOFF - SNAPSHOTTING - SOFT_DELETED - STOPPED - SUSPENDED - UNKNOWN - UNRESCUING - UNSHELVING - VERIFY_RESIZE cloud.instance.InstanceSummary: type: object description: Instance properties: addresses: type: array description: Instance IP addresses items: "$ref": "#/components/schemas/cloud.instance.InstanceAddress" readOnly: true attachedVolumes: type: array description: Volumes attached to the instance items: "$ref": "#/components/schemas/cloud.instance.InstanceSummaryVolumeValue" readOnly: true flavorId: type: string description: Flavor id format: uuid readOnly: true flavorName: type: string description: Flavor name readOnly: true id: type: string description: Instance id format: uuid readOnly: true imageId: type: string description: Image id format: uuid readOnly: true name: type: string description: Instance name readOnly: true region: type: string description: Instance region readOnly: true sshKey: type: string description: Instance SSH key name readOnly: true taskState: allOf: - "$ref": "#/components/schemas/cloud.instance.InstanceSummaryTaskStateEnum" description: Instance task state readOnly: true cloud.instance.InstanceSummaryTaskStateEnum: type: string description: Enum values for taskState of an instance enum: - '' - BlockDeviceMapping - Deleting - ImagePendingUpload - ImageSnapshot - ImageUpload - Migrating - Networking - Pausing - PoweringOff - PoweringOn - Rebooting - RebootingHard - RebuildBlockDeviceMapping - RebuildSpawning - Rebuilding - Rescuing - ResizeConfirming - ResizeFinish - ResizeMigrated - ResizeMigrating - ResizePrep - ResizeReverting - Resuming - Scheduling - Spawning - Starting - Stopping - Suspending - Unknown - Unpausing - Unrescuing - UpdatingPassword cloud.instance.InstanceSummaryVolumeValue: type: object description: Volumes attached to your instance properties: id: type: string description: Volume Id format: uuid readOnly: true cloud.instance.InstanceVnc: type: object description: InstanceVnc properties: type: type: string description: VNC type readOnly: true url: type: string description: VNC url readOnly: true cloud.instance.IpAddress: type: object description: IpAddress properties: gatewayIp: allOf: - "$ref": "#/components/schemas/ip" description: Gateway IP nullable: true readOnly: true ip: type: string description: Instance IP address readOnly: true networkId: type: string description: Network ID readOnly: true type: type: string description: Instance IP address type readOnly: true version: type: integer description: IP version readOnly: true cloud.instance.MetricsPeriodEnum: type: string description: MetricsPeriod enum: - lastday - lastmonth - lastweek - lastyear - today cloud.instance.MetricsTypeEnum: type: string description: MetricsType enum: - cpu:max - cpu:used - mem:max - mem:used - net:rx - net:tx cloud.instance.MonthlyBilling: type: object description: MonthlyBilling properties: since: type: string description: Monthly billing activated since format: date-time readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.instance.MonthlyBillingStatusEnum" description: Monthly billing status readOnly: true cloud.instance.MonthlyBillingStatusEnum: type: string description: MonthlyBillingStatusEnum enum: - activationPending - ok cloud.instance.MonthlyInstanceBulkParams: type: object description: Instance with region to set as monthly billing properties: instanceId: type: string description: Instance id format: uuid region: type: string description: Region name cloud.instance.NetworkBulkParams: type: object description: NetworkBulkParams properties: networkId: type: string description: Private or public network Id cloud.instance.NetworkParams: type: object description: NetworkParams properties: ip: allOf: - "$ref": "#/components/schemas/ip" description: Static ip (Can only be defined for private networks) nullable: true networkId: type: string description: Private or public network Id cloud.instance.RebootTypeEnum: type: string description: RebootTypeEnum enum: - hard - soft cloud.instance.RescueAdminPassword: type: object description: RescueAdminPassword properties: adminPassword: type: string description: Admin password to connect to your rescue server with nullable: true format: password readOnly: true cloud.instanceInterface.FixedIp: type: object description: FixedIp properties: ip: type: string description: Ip readOnly: true subnetId: type: string description: Subnetwork Id readOnly: true cloud.instanceInterface.Interface: type: object description: Interface properties: fixedIps: type: array description: List of ips of the interface items: "$ref": "#/components/schemas/cloud.instanceInterface.FixedIp" readOnly: true id: type: string description: Interface unique identifier readOnly: true macAddress: type: string description: Mac address readOnly: true networkId: type: string description: Network id readOnly: true state: type: string description: Openstack state readOnly: true type: type: string description: Network type readOnly: true cloud.instancegroup.InstanceGroup: type: object description: InstanceGroup properties: id: type: string description: Instance group id readOnly: true instance_ids: type: array description: Instances ids items: type: string readOnly: true name: type: string description: Instance group name readOnly: true region: type: string description: region readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.instancegroup.InstanceGroupTypeEnum" description: Instance group type readOnly: true cloud.instancegroup.InstanceGroupTypeEnum: type: string description: InstanceGroupTypeEnum enum: - affinity - anti-affinity cloud.ip.CloudIp: type: object description: CloudIp properties: id: type: string description: Ip id readOnly: true ip: allOf: - "$ref": "#/components/schemas/ipBlock" description: Ip nullable: true readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.ip.IpStatusEnum" description: Ip status readOnly: true type: type: string description: Ip type readOnly: true cloud.ip.FailoverIp: type: object description: FailoverIp properties: block: allOf: - "$ref": "#/components/schemas/ip" description: IP block nullable: true readOnly: true continentCode: type: string description: Ip continent nullable: true readOnly: true geoloc: type: string description: Ip location nullable: true readOnly: true id: type: string description: Ip id readOnly: true ip: allOf: - "$ref": "#/components/schemas/ip" description: Ip nullable: true readOnly: true progress: type: integer description: Current operation progress in percent readOnly: true routedTo: type: string description: Instance where ip is routed to readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.ip.IpStatusEnum" description: Ip status readOnly: true subType: allOf: - "$ref": "#/components/schemas/cloud.ip.IpSubTypeEnum" description: IP sub type readOnly: true cloud.ip.IpStatusEnum: type: string description: IpStatusEnum enum: - ok - operationPending cloud.ip.IpSubTypeEnum: type: string description: IpSubTypeEnum enum: - cloud - ovh cloud.keymanager.Certificate: type: object description: Key-manager certificate secret container properties: id: type: string description: ID of the certificate format: uuid readOnly: true name: type: string description: Name of the certificate readOnly: true region: type: string description: Certificate region readOnly: true secrets: type: array description: List of secrets in certificate container items: "$ref": "#/components/schemas/cloud.keymanager.SecretRef" readOnly: true cloud.keymanager.CertificateCreate: type: object description: Input to create a certificate properties: certificate: type: string description: Content of the certificate format: password intermediates: type: string description: Content of the intermediates certificates if any format: password name: type: string description: Name of the certificate privateKey: type: string description: Private key format: password privateKeyPassphrase: type: string description: Private key passphrase if any format: password required: - certificate - name - privateKey cloud.keymanager.Secret: type: object description: secret properties: id: type: string description: ID of the secret format: uuid readOnly: true name: type: string description: Name of the secret readOnly: true region: type: string description: Secret region readOnly: true cloud.keymanager.SecretRef: type: object description: Secret reference properties: id: type: string description: ID of the secret format: uuid readOnly: true name: type: string description: Name of the secret readOnly: true cloud.kube.Cluster: type: object description: Managed Kubernetes cluster description properties: auditLogsSubscribed: type: boolean description: True if cluster auditlogs forward has been subscribed readOnly: true controlPlaneIsUpToDate: type: boolean description: True if control-plane is up to date readOnly: true createdAt: type: string description: Cluster creation date format: date-time readOnly: true customization: allOf: - "$ref": "#/components/schemas/cloud.ProjectKubeCustomization" description: Kubernetes cluster customization nullable: true readOnly: true id: type: string description: Cluster ID readOnly: true isUpToDate: type: boolean description: True if all nodes and control-plane are up to date readOnly: true kubeProxyMode: allOf: - "$ref": "#/components/schemas/cloud.kube.KubeProxyModeEnum" description: Selected mode for kube-proxy readOnly: true loadBalancersSubnetId: type: string description: OpenStack subnet ID that the load balancers will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId and nodesSubnetId are also set nullable: true format: uuid readOnly: true name: type: string description: Cluster name readOnly: true nextUpgradeVersions: type: array description: Kubernetes versions available for upgrade nullable: true items: type: string readOnly: true nodesSubnetId: type: string description: OpenStack subnet ID that the cluster nodes will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId is also set. If unspecified, it will be selected automatically when the first node is created. nullable: true readOnly: true nodesUrl: type: string description: Cluster nodes URL readOnly: true privateNetworkConfiguration: allOf: - "$ref": "#/components/schemas/cloud.kube.PrivateNetworkConfiguration" description: The private network configuration. This field is optional. nullable: true readOnly: true privateNetworkId: type: string description: OpenStack private network ID that the cluster will use. Optional, can only be set on cluster creation or reset. If unspecified, the cluster will use the public network. nullable: true readOnly: true region: type: string description: 'Cluster region. Example: GRA11.' readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.kube.ClusterStatusEnum" description: Cluster status readOnly: true updatePolicy: type: string description: Cluster update policy readOnly: true updatedAt: type: string description: Cluster last update date format: date-time readOnly: true url: type: string description: Management URL of your cluster readOnly: true version: type: string description: Kubernetes version of your cluster readOnly: true cloud.kube.ClusterStatusEnum: type: string description: Enum values for Status enum: - DELETED - DELETING - ERROR - INSTALLING - MAINTENANCE - READY - REDEPLOYING - REOPENING - RESETTING - SUSPENDED - SUSPENDING - UPDATING - USER_ERROR - USER_QUOTA_ERROR - USER_WEBHOOK_PREVENTING_OPERATIONS_ERROR cloud.kube.EtcdUsage: type: object description: Etcd usage and quota for a given cluster properties: quota: type: integer description: Maximum allowed size of etcd data for the cluster (bytes) readOnly: true usage: type: integer description: Size of etcd data used by the cluster (bytes) readOnly: true cloud.kube.Flavor: type: object description: a flavor kind properties: category: allOf: - "$ref": "#/components/schemas/cloud.kube.FlavorCategoryEnum" description: Flavor family readOnly: true gpus: type: integer description: Number of GPUs readOnly: true name: type: string description: Flavor name readOnly: true ram: type: integer description: Ram quantity (GB) readOnly: true state: allOf: - "$ref": "#/components/schemas/cloud.kube.FlavorStateEnum" description: Flavor state readOnly: true vCPUs: type: integer description: Number of VCPUs readOnly: true cloud.kube.FlavorCategoryEnum: type: string description: Enum values for category enum: - a - b - c - d - g - h - i - l - r - t cloud.kube.FlavorStateEnum: type: string description: Enum values for State enum: - available - unavailable cloud.kube.KubeProxyIpvsSchedulerEnum: type: string description: Enum values for scheduler parameter of cluster kubeProxy custom ipvs config enum: - dh - lc - nq - rr - sed - sh cloud.kube.KubeProxyModeEnum: type: string description: Enum values for cluster kubeProxyMode enum: - iptables - ipvs cloud.kube.Kubeconfig: type: object description: Kubeconfig description properties: content: type: string description: kubeconfig file format: password readOnly: true cloud.kube.Node: type: object description: Node installed on your cluster properties: createdAt: type: string description: Creation date format: date-time readOnly: true deployedAt: type: string description: Node deployment date nullable: true format: date-time readOnly: true flavor: type: string description: Flavor name readOnly: true id: type: string description: Node ID readOnly: true instanceId: type: string description: Public Cloud instance id nullable: true readOnly: true isUpToDate: type: boolean description: True if the node is up to date readOnly: true name: type: string description: Node name readOnly: true nodePoolId: type: string description: NodePool parent id readOnly: true projectId: type: string description: Project id readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.kube.NodeStatusEnum" description: Status readOnly: true updatedAt: type: string description: Node last update date format: date-time readOnly: true version: type: string description: Node version readOnly: true cloud.kube.NodePool: type: object description: NodePool created on your cluster to manage your nodes properties: antiAffinity: type: boolean description: Enable anti affinity groups for nodes in the pool readOnly: true autoscale: type: boolean description: Enable auto-scaling for the pool readOnly: true autoscaling: allOf: - "$ref": "#/components/schemas/cloud.kube.NodePoolAutoscaling" description: Autoscaling customization parameters readOnly: true availableNodes: type: integer description: Number of nodes which are actually ready in the pool readOnly: true createdAt: type: string description: Creation date format: date-time readOnly: true currentNodes: type: integer description: Number of nodes present in the pool readOnly: true desiredNodes: type: integer description: Number of nodes you desire in the pool readOnly: true flavor: type: string description: Flavor name readOnly: true id: type: string description: NodePool ID readOnly: true maxNodes: type: integer description: Number of nodes you desire in the pool readOnly: true minNodes: type: integer description: Number of nodes you desire in the pool readOnly: true monthlyBilled: type: boolean description: Enable monthly billing on all nodes in the pool readOnly: true name: type: string description: NodePool resource name readOnly: true projectId: type: string description: Project id readOnly: true sizeStatus: allOf: - "$ref": "#/components/schemas/cloud.kube.NodePoolSizeStatusEnum" description: Status describing the state between number of nodes wanted and available ones readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.kube.NodePoolStatusEnum" description: Current status readOnly: true template: allOf: - "$ref": "#/components/schemas/cloud.kube.NodePoolTemplate" description: Template of nodes metadata and spec to create in the pool readOnly: true upToDateNodes: type: integer description: Number of nodes with latest version installed in the pool readOnly: true updatedAt: type: string description: Last update date format: date-time readOnly: true cloud.kube.NodePoolAutoscaling: type: object description: Autoscaling customization parameters properties: scaleDownUnneededTimeSeconds: type: integer description: How long a node should be unneeded before it is eligible for scale down readOnly: true scaleDownUnreadyTimeSeconds: type: integer description: How long an unready node should be unneeded before it is eligible for scale down readOnly: true scaleDownUtilizationThreshold: type: number description: Sum of cpu or memory of all pods running on the node divided by node's corresponding allocatable resource, below which a node can be considered for scale down readOnly: true cloud.kube.NodePoolSizeStatusEnum: type: string description: Enum values for NodePool size Status enum: - CAPACITY_OK - OVER_CAPACITY - UNDER_CAPACITY cloud.kube.NodePoolStatusEnum: type: string description: Enum values for NodePool Status enum: - DELETED - DELETING - DOWNSCALING - ERROR - INSTALLING - MAINTENANCE - READY - REDEPLOYING - REOPENING - RESETTING - SUSPENDED - SUSPENDING - UPDATING - UPSCALING - USER_ERROR - USER_NODE_NOT_FOUND_ERROR - USER_NODE_SUSPENDED_SERVICE - USER_QUOTA_ERROR - USER_WEBHOOK_PREVENTING_OPERATIONS_ERROR cloud.kube.NodePoolTemplate: type: object description: Managed Kubernetes nodepool template properties: metadata: description: Metadata of each nodes in the pool "$ref": "#/components/schemas/cloud.kube.NodePoolTemplateMetadata" spec: description: Spec of each nodes in the pool "$ref": "#/components/schemas/cloud.kube.NodePoolTemplateSpec" required: - metadata - spec cloud.kube.NodePoolTemplateMetadata: type: object description: Metadata of each nodes in the pool properties: annotations: type: object description: Annotations to apply to each nodes additionalProperties: type: string finalizers: type: array description: Finalizers to apply to each nodes items: type: string labels: type: object description: Labels to apply to each nodes additionalProperties: type: string required: - annotations - finalizers - labels cloud.kube.NodePoolTemplateSpec: type: object description: Spec of each nodes in the pool properties: taints: type: array description: Taints to apply to each nodes items: "$ref": "#/components/schemas/cloud.kube.Taint" unschedulable: type: boolean description: If true, set nodes as un-schedulable required: - taints - unschedulable cloud.kube.NodeStatusEnum: type: string description: Enum values for Status enum: - DELETED - DELETING - ERROR - FLAVOR_OUT_OF_STOCK_ERROR - INSTALLING - MAINTENANCE - READY - REDEPLOYING - REOPENING - RESETTING - SUSPENDED - SUSPENDING - UPDATING - USER_ERROR - USER_NODE_NOT_FOUND_ERROR - USER_NODE_SUSPENDED_SERVICE - USER_QUOTA_ERROR - USER_WEBHOOK_PREVENTING_OPERATIONS_ERROR cloud.kube.OpenIdConnect: type: object description: Managed Kubernetes oidc integration properties: caContent: type: string description: Content of the certificate for the CA, in base64 format, that signed your identity provider's web certificate. Defaults to the host's root CAs. nullable: true readOnly: true clientId: type: string description: Client ID readOnly: true groupsClaim: type: array description: JWT claim to use as the user's group. If the claim is present it must be an array of strings. nullable: true items: type: string readOnly: true groupsPrefix: type: string description: 'Prefix prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra.' nullable: true readOnly: true issuerUrl: type: string description: Issuer URL readOnly: true requiredClaim: type: array description: key=value pairs that describe required claims in the ID Token. If set, the claims are verified to be present in the ID Token with a matching value. nullable: true items: type: string readOnly: true signingAlgorithms: type: array description: The signing algorithms accepted. Default is "RS256". nullable: true items: "$ref": "#/components/schemas/cloud.kube.OpenIdConnectSigningAlgorithmsEnum" readOnly: true usernameClaim: type: string description: JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins. nullable: true readOnly: true usernamePrefix: type: string description: 'Prefix prepended to username claims to prevent clashes with existing names (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. If this field isn''t set and oidcUsernameClaim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of oidcIssuerUrl. The value - can be used to disable all prefixing.' nullable: true readOnly: true cloud.kube.OpenIdConnectSigningAlgorithmsEnum: type: string description: Enum values for OpenIdConnect signing algorithms enum: - ES256 - ES384 - ES512 - PS256 - PS384 - PS512 - RS256 - RS384 - RS512 cloud.kube.PrivateNetworkConfiguration: type: object description: Managed Kubernetes cluster private networking configuration properties: defaultVrackGateway: type: string description: If defined, all egress traffic will be routed towards this IP address, which should belong to the private network. Empty string means disabled. privateNetworkRoutingAsDefault: type: boolean description: Defines whether routing should default to using the nodes' private interface, instead of their public interface. Default is false. nullable: true cloud.kube.ResetWorkerNodesPolicyEnum: type: string description: Enum values for worker nodes reset policy enum: - delete - reinstall cloud.kube.ResponseMessage: type: object description: A generic object for response message properties: message: type: string description: The response message. readOnly: true cloud.kube.Taint: type: object description: Kubernetes taint object properties: effect: description: The effect of the taint on pods that do not tolerate the taint. Valid effects are NoSchedule, PreferNoSchedule and NoExecute "$ref": "#/components/schemas/cloud.kube.TaintEffectEnum" key: type: string description: The taint key to be applied to a node value: type: string description: The taint value corresponding to the taint key required: - effect - key - value cloud.kube.TaintEffectEnum: type: string description: Enum values for taint effects enum: - NoExecute - NoSchedule - PreferNoSchedule cloud.kube.UpdatePolicyEnum: type: string description: Enum values for UpdatePolicy enum: - ALWAYS_UPDATE - MINIMAL_DOWNTIME - NEVER_UPDATE cloud.kube.UpdateStrategyEnum: type: string description: Enum values for UpdateStrategy enum: - LATEST_PATCH - NEXT_MINOR cloud.kube.VersionEnum: type: string description: List of available versions for installation enum: - '1.26' - '1.27' - '1.28' - '1.29' cloud.loadbalancing.AssociateFloatingIp: type: object description: Parameters to associate an existing floating IP to a loadbalancer properties: floatingIpId: type: string description: Floating IP ID format: uuid gateway: allOf: - "$ref": "#/components/schemas/cloud.network.CreateGatewaySummary" description: Parameters to create a gateway if required nullable: true ip: description: Private loadbalancer IP to associate the floating IP with "$ref": "#/components/schemas/ip" required: - floatingIpId - ip cloud.loadbalancing.CreateFloatingIp: type: object description: Parameters to create a floating IP for a loadbalancer properties: gateway: allOf: - "$ref": "#/components/schemas/cloud.network.CreateGatewaySummary" description: Parameters to create a gateway if required nullable: true ip: description: Private loadbalancer IP to associate the floating IP with "$ref": "#/components/schemas/ip" required: - ip cloud.loadbalancing.CreateListener: type: object description: Input to create a loadbalancer listener properties: allowedCidrs: type: array description: The allowed CIDRs items: "$ref": "#/components/schemas/ipv4Block" certificateId: type: string description: The ID of the secret containing the certificate format: uuid defaultPoolId: type: string description: The ID of the default pool format: uuid description: type: string description: The description of the listener loadbalancerId: type: string description: The ID of the loadbalancer format: uuid name: type: string description: The name of the listener port: type: integer description: Port to listen on protocol: description: Protocol of the listener "$ref": "#/components/schemas/cloud.loadbalancing.ListenerProtocolEnum" timeoutClientData: type: integer description: Timeout client data of the listener timeoutMemberData: type: integer description: Timeout member data of the listener tlsVersions: type: array description: TLS versions of the listener items: "$ref": "#/components/schemas/cloud.loadbalancing.ListenerTlsVersionEnum" required: - loadbalancerId - name - port - protocol cloud.loadbalancing.EditListener: type: object description: Edit a loadbalancer listener properties: allowedCidrs: type: array description: The allowed CIDRs items: "$ref": "#/components/schemas/ipv4Block" certificateId: type: string description: ID of the secret containing the certificate defaultPoolId: type: string description: ID of the default pool format: uuid description: type: string description: Description of the listener name: type: string description: Name of the listener cloud.loadbalancing.Flavor: type: object description: Flavor properties: id: type: string description: Flavor id format: uuid readOnly: true name: type: string description: Flavor name readOnly: true region: type: string description: Region name readOnly: true cloud.loadbalancing.HealthMonitor: type: object description: HealthMonitor properties: delay: type: integer description: Duration between sending probes to members, in seconds httpConfiguration: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.HealthMonitorHTTPConfiguration" description: Monitor HTTP configuration nullable: true id: type: string description: The ID of the pool format: uuid readOnly: true maxRetries: type: integer description: Number of successful checks before changing the operating status of the member to ONLINE maxRetriesDown: type: integer description: Number of allowed check failures before changing the operating status of the member to ERROR nullable: true monitorType: description: Type of the monitor "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerHealthMonitorTypeEnum" name: type: string description: The name of the resource operatingStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerOperatingStatusEnum" description: The operating status of the resource readOnly: true poolId: type: string description: The ID of the pool format: uuid provisioningStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerProvisioningStatusEnum" description: The provisioning status of the resource readOnly: true timeout: type: integer description: Maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value required: - delay - maxRetries - monitorType - name - poolId - timeout cloud.loadbalancing.HealthMonitorCreate: type: object description: Create a health monitor on loadbalancer creation properties: delay: type: integer description: Duration between sending probes to members, in seconds httpConfiguration: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.HealthMonitorHTTPConfiguration" description: Monitor HTTP configuration nullable: true maxRetries: type: integer description: Number of successful checks before changing the operating status of the member to ONLINE maxRetriesDown: type: integer description: Number of allowed check failures before changing the operating status of the member to ERROR nullable: true monitorType: description: Type of the monitor "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerHealthMonitorTypeEnum" name: type: string description: The name of the resource operatingStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerOperatingStatusEnum" description: The operating status of the resource readOnly: true provisioningStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerProvisioningStatusEnum" description: The provisioning status of the resource readOnly: true timeout: type: integer description: Maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value required: - delay - maxRetries - monitorType - name - timeout cloud.loadbalancing.HealthMonitorHTTPConfiguration: type: object description: HTTP configuration for loadbalancer health monitor properties: domainName: type: string description: Domain name, which be injected into the HTTP Host Header to the backend server for HTTP health check expectedCodes: type: string description: 'Status codes expected in response from the member to declare it healthy; The list of HTTP status codes expected in response from the member to declare it healthy. Specify one of the following values: * A single value, such as 200; * A list, such as 200, 202; * A range, such as 200-204' httpMethod: description: HTTP method that the health monitor uses for requests "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerHealthMonitorHTTPMethodEnum" httpVersion: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerHealthMonitorHTTPVersionEnum" description: HTTP version that the health monitor uses for requests nullable: true urlPath: type: string description: HTTP URL path of the request sent by the monitor to test the health of a backend member required: - httpMethod cloud.loadbalancing.L7Policy: type: object description: L7 policy properties: action: description: The L7 policy action "$ref": "#/components/schemas/cloud.loadbalancing.L7PolicyActionEnum" description: type: string description: A human-readable description for the resource id: type: string format: uuid readOnly: true listenerId: type: string description: The ID of the listener. format: uuid name: type: string description: Human-readable name of the resource operatingStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerOperatingStatusEnum" description: Operating status of the resource readOnly: true position: type: integer description: The position of this policy on the listener. Positions start at 1 provisioningStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerProvisioningStatusEnum" description: provisioning status of the resource readOnly: true redirectHttpCode: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.L7PolicyRedirectHTTPCodeEnum" description: Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if action is "redirect_to" or "redirect_prefix" nullable: true redirectPoolId: type: string description: Requests matching this policy will be redirected to the pool with this ID. Only valid if action is "redirect_to_pool" nullable: true format: uuid redirectPrefix: type: string description: Requests matching this policy will be redirected to this Prefix URL. Only valid if action is "redirect_prefix" nullable: true redirectUrl: type: string description: Requests matching this policy will be redirected to this URL. Only valid if action is "redirect_to_url" nullable: true required: - action - listenerId cloud.loadbalancing.L7PolicyActionEnum: type: string description: Loadbalancer L7 policy enum: - redirectPrefix - redirectToPool - redirectToURL - reject cloud.loadbalancing.L7PolicyRedirectHTTPCodeEnum: type: integer description: Loadbalancer L7 policy redirect HTTP code enum: - 301 - 302 - 303 - 307 - 308 cloud.loadbalancing.L7PolicyUpdate: type: object description: L7 policy properties: action: description: The L7 policy action "$ref": "#/components/schemas/cloud.loadbalancing.L7PolicyActionEnum" description: type: string description: A human-readable description for the resource listenerId: type: string description: The ID of the listener. format: uuid name: type: string description: Human-readable name of the resource position: type: integer description: The position of this policy on the listener. Positions start at 1 redirectHttpCode: type: integer description: Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if action is "redirect_to" or "redirect_prefix" nullable: true redirectPoolId: type: string description: Requests matching this policy will be redirected to the pool with this ID. Only valid if action is "redirect_to_pool" nullable: true format: uuid redirectPrefix: type: string description: Requests matching this policy will be redirected to this Prefix URL. Only valid if action is "redirect_prefix" nullable: true redirectUrl: type: string description: Requests matching this policy will be redirected to this URL. Only valid if action is "redirect_to_url" nullable: true required: - action cloud.loadbalancing.L7Rule: type: object description: L7 rule properties: compareType: description: The comparison type for the L7 rule "$ref": "#/components/schemas/cloud.loadbalancing.L7RuleCompareTypeEnum" id: type: string description: The ID of the L7 rule format: uuid readOnly: true invert: type: boolean description: When true the logic of the rule is inverted. For example, with invert set to true, equal to would become not equal to key: type: string description: The key to use for the comparison. For example, the name of the cookie to evaluate operatingStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerOperatingStatusEnum" description: Operating status of the resource readOnly: true provisioningStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerProvisioningStatusEnum" description: provisioning status of the resource readOnly: true ruleType: description: The L7 rule type "$ref": "#/components/schemas/cloud.loadbalancing.L7RuleTypeEnum" value: type: string description: The value to use for the comparison. For example, the file type to compare required: - compareType - ruleType - value cloud.loadbalancing.L7RuleCompareTypeEnum: type: string description: Loadbalancer L7 rule compare type enum: - contains - endsWith - equalTo - regex - startsWith cloud.loadbalancing.L7RuleTypeEnum: type: string description: Loadbalancer L7 rule type enum: - cookie - fileType - header - hostName - path - sslConnHasCert - sslDNField - sslVerifyResult cloud.loadbalancing.Listener: type: object description: Listener properties: allowedCidrs: type: array description: The allowed CIDRs nullable: true items: "$ref": "#/components/schemas/ipv4Block" readOnly: true certificateId: type: string description: The ID of the secret containing the certificate nullable: true format: uuid readOnly: true defaultPoolId: type: string description: The ID of the default pool nullable: true format: uuid readOnly: true description: type: string description: Description of the listener nullable: true readOnly: true id: type: string description: ID of the resource format: uuid readOnly: true loadBalancerIds: type: array description: A list of load balancer IDs items: type: string format: uuid readOnly: true name: type: string description: Name of the resource readOnly: true operatingStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerOperatingStatusEnum" description: Operating status of the listener readOnly: true port: type: integer description: Port to listen on readOnly: true protocol: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.ListenerProtocolEnum" description: Protocol of the listener readOnly: true provisioningStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerProvisioningStatusEnum" description: Provisioning status of the listener readOnly: true timeoutClientData: type: integer description: Timeout client data of the listener nullable: true readOnly: true timeoutMemberData: type: integer description: Timeout member data of the listener nullable: true readOnly: true tlsVersions: type: array description: TLS versions of the listener nullable: true items: "$ref": "#/components/schemas/cloud.loadbalancing.ListenerTlsVersionEnum" readOnly: true cloud.loadbalancing.ListenerProtocolEnum: type: string description: Loadbalancer listener protocol enum: - http - https - prometheus - sctp - tcp - terminatedHTTPS - udp cloud.loadbalancing.ListenerTlsVersionEnum: type: string description: Loadbalancer listener TLS versions enum: - SSLv3 - TLSv1 - TLSv1.1 - TLSv1.2 - TLSv1.3 cloud.loadbalancing.LoadBalancer: type: object description: LoadBalancer properties: createdAt: type: string description: The UTC date and timestamp when the resource was created format: date-time readOnly: true flavorId: type: string description: ID of the flavor format: uuid readOnly: true floatingIp: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancer.FloatingIp" description: Information about floating IP nullable: true readOnly: true id: type: string description: ID of the resource format: uuid readOnly: true name: type: string description: Name of the resource readOnly: true operatingStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerOperatingStatusEnum" description: Operating status of the resource readOnly: true provisioningStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerProvisioningStatusEnum" description: Provisioning status of the resource readOnly: true region: type: string description: Region of the resource readOnly: true updatedAt: type: string description: UTC date and timestamp when the resource was created format: date-time readOnly: true vipAddress: allOf: - "$ref": "#/components/schemas/ip" description: IP address of the Virtual IP readOnly: true vipNetworkId: type: string description: Openstack ID of the network for the Virtual IP format: uuid readOnly: true vipSubnetId: type: string description: ID of the subnet for the Virtual IP format: uuid readOnly: true cloud.loadbalancing.LoadBalancer.FloatingIp: type: object description: LoadBalancerFloatingIp properties: id: type: string description: ID of the resource format: uuid readOnly: true ip: allOf: - "$ref": "#/components/schemas/ip" description: IP Address of the resource readOnly: true cloud.loadbalancing.LoadBalancerHealthMonitorHTTPMethodEnum: type: string description: Load balancer Healthmonitor HTTP Method enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE cloud.loadbalancing.LoadBalancerHealthMonitorHTTPVersionEnum: type: string description: Load balancer Healthmonitor HTTP Version enum: - '1.0' - '1.1' cloud.loadbalancing.LoadBalancerHealthMonitorTypeEnum: type: string description: Load balancer Healthmonitor type enum: - http - https - ping - sctp - tcp - tls-hello - udp-connect cloud.loadbalancing.LoadBalancerOperatingStatusEnum: type: string description: Load balancer operating status enum: - degraded - draining - error - noMonitor - offline - online cloud.loadbalancing.LoadBalancerProvisioningStatusEnum: type: string description: Load balancer provisioning status enum: - active - creating - deleted - deleting - error - updating cloud.loadbalancing.Loadbalancer.CreateInput: type: object description: Create a loadbalancer properties: flavorId: type: string description: Loadbalancer flavor id format: uuid listeners: type: array description: Listeners to create with the loadbalancer items: "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.ListenerCreate" name: type: string description: Name of the member network: description: Network information to create the loadbalancer "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.CreateInput.Network" required: - flavorId - network cloud.loadbalancing.LoadbalancerEdit: type: object description: Edit a loadbalancer properties: description: type: string description: Description of the loadbalancer name: type: string description: Name of the member cloud.loadbalancing.Pool: type: object description: Pool properties: algorithm: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.PoolAlgorithmEnum" description: Algorithm of the pool readOnly: true id: type: string description: ID of the resource format: uuid readOnly: true listenerId: type: string description: ID of the listener nullable: true format: uuid readOnly: true loadbalancerId: type: string description: ID of the loadbalancer format: uuid readOnly: true name: type: string description: Name of the resource readOnly: true operatingStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerOperatingStatusEnum" description: Operating status of the resource readOnly: true protocol: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.PoolProtocolEnum" description: Protocol of the pool readOnly: true provisioningStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerProvisioningStatusEnum" description: Provisioning status of the resource readOnly: true sessionPersistence: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.PoolSessionPersistence" description: Information about session persistence nullable: true readOnly: true cloud.loadbalancing.PoolAlgorithmEnum: type: string description: Pool algorithm enum: - leastConnections - roundRobin - sourceIP cloud.loadbalancing.PoolCreate: type: object description: Pool properties: algorithm: description: Algorithm of the pool "$ref": "#/components/schemas/cloud.loadbalancing.PoolAlgorithmEnum" listenerId: type: string description: ID of the listener format: uuid loadbalancerId: type: string description: ID of the loadbalancer format: uuid name: type: string description: Name of the resource protocol: description: Protocol of the pool "$ref": "#/components/schemas/cloud.loadbalancing.PoolProtocolEnum" sessionPersistence: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.PoolSessionPersistence" description: Information about session persistence nullable: true required: - algorithm - protocol cloud.loadbalancing.PoolProtocolEnum: type: string description: Pool protocol enum: - http - https - proxy - proxyV2 - sctp - tcp - udp cloud.loadbalancing.PoolSessionPersistence: type: object description: PoolSessionPersistence properties: cookieName: type: string description: Cookie name, only applicable to session persistence through cookie type: description: Type of session persistence "$ref": "#/components/schemas/cloud.loadbalancing.PoolSessionPersistenceTypeEnum" cloud.loadbalancing.PoolSessionPersistenceTypeEnum: type: string description: Pool session persistence type enum: - appCookie - disabled - httpCookie - sourceIP cloud.loadbalancing.PoolUpdate: type: object description: Parameters to update a load balancer pool properties: algorithm: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.PoolAlgorithmEnum" description: Algorithm of the pool nullable: true name: type: string description: Name of the resource nullable: true sessionPersistence: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.PoolSessionPersistence" nullable: true cloud.loadbalancing.UpdateHealthMonitor: type: object description: Health monitor for LoadBalancer properties: delay: type: integer description: Duration between sending probes to members, in seconds httpConfiguration: description: Monitor HTTP configuration "$ref": "#/components/schemas/cloud.loadbalancing.HealthMonitorHTTPConfiguration" maxRetries: type: integer description: Number of successful checks before changing the operating status of the member to ONLINE maxRetriesDown: type: integer description: Number of allowed check failures before changing the operating status of the member to ERROR name: type: string description: The name of the resource timeout: type: integer description: Maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value cloud.loadbalancing.loadbalancer.CreateInput.Network: type: object description: Network information to create a loadbalancer properties: private: description: Information to private network "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.CreateInput.Network.Private" required: - private cloud.loadbalancing.loadbalancer.CreateInput.Network.Private: type: object description: Network information to create a loadbalancer properties: floatingIp: description: Floating IP to associate "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.CreateInput.Network.Private.FloatingIp" floatingIpCreate: description: Floating IP to create "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.CreateInput.Network.Private.FloatingIpCreate" gateway: description: Gateway to associate "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.CreateInput.Network.Private.Gateway" gatewayCreate: description: Gateway to create "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.CreateInput.Network.Private.GatewayCreate" network: description: Network to associate "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.CreateInput.Network.Private.Network" required: - network cloud.loadbalancing.loadbalancer.CreateInput.Network.Private.FloatingIp: type: object description: Information to attach floatingIp properties: id: type: string description: ID of the floatingIp format: uuid required: - id cloud.loadbalancing.loadbalancer.CreateInput.Network.Private.FloatingIpCreate: type: object description: Information to create floatingIp properties: description: type: string description: Description for the floatingIp required: - description cloud.loadbalancing.loadbalancer.CreateInput.Network.Private.Gateway: type: object description: Information to attach Gateway properties: id: type: string description: ID of the gateway format: uuid required: - id cloud.loadbalancing.loadbalancer.CreateInput.Network.Private.GatewayCreate: type: object description: Information to create a Gateway properties: model: description: Model of the gateway "$ref": "#/components/schemas/cloud.network.GatewayModelEnum" name: type: string description: Name of the gateway required: - model - name cloud.loadbalancing.loadbalancer.CreateInput.Network.Private.Network: type: object description: Network information to associate a network properties: id: type: string description: Private network ID format: uuid subnetId: type: string description: Subnet ID format: uuid required: - id - subnetId cloud.loadbalancing.loadbalancer.ListenerCreate: type: object description: Create a listener on loadbalancer creation properties: allowedCidrs: type: array description: The allowed CIDRs items: "$ref": "#/components/schemas/ipv4Block" description: type: string description: The description of the listener name: type: string description: Name of the listener pool: description: Listener pool "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.PoolCreate" port: type: integer description: Listener port protocol: description: Protocol for the listener "$ref": "#/components/schemas/cloud.loadbalancing.ListenerProtocolEnum" secretId: type: string description: Secret ID to get certificate for SSL listener creation format: uuid timeoutClientData: type: integer description: Timeout client data of the listener timeoutMemberData: type: integer description: Timeout member data of the listener tlsVersions: type: array description: TLS versions of the listener items: "$ref": "#/components/schemas/cloud.loadbalancing.ListenerTlsVersionEnum" required: - port - protocol cloud.loadbalancing.loadbalancer.MemberCreate: type: object description: Create a member on loadbalancer creation properties: address: description: IP address of the resource "$ref": "#/components/schemas/ip" name: type: string description: Name of the member protocolPort: type: integer description: Protocol port number for the resource weight: type: integer description: Weight of a member determines the portion of requests or connections it services compared to the other members of the pool. Between 1 and 256. nullable: true required: - address - protocolPort cloud.loadbalancing.loadbalancer.PoolCreate: type: object description: Create a pool on loadbalancer creation properties: algorithm: description: Pool algorithm to split traffic between members "$ref": "#/components/schemas/cloud.loadbalancing.PoolAlgorithmEnum" healthMonitor: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.HealthMonitorCreate" description: Pool health monitor nullable: true members: type: array description: Pool members items: "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.MemberCreate" name: type: string description: Name of the pool protocol: description: Protocol for the pool "$ref": "#/components/schemas/cloud.loadbalancing.PoolProtocolEnum" sessionPersistence: description: Pool session persistence "$ref": "#/components/schemas/cloud.loadbalancing.PoolSessionPersistence" required: - algorithm - protocol cloud.loadbalancing.loadbalancer.Stats: type: object description: Loadbalancer statistics properties: activeConnections: type: integer description: Number of currently active connections readOnly: true bytesIn: type: integer description: Total bytes received readOnly: true bytesOut: type: integer description: Total bytes sent readOnly: true requestErrors: type: integer description: Total requests that were unable to be fulfilled readOnly: true totalConnections: type: integer description: Total connections handled readOnly: true cloud.loadbalancing.pool.CreateMembers: type: object description: Pool Members properties: members: type: array description: Members of a pool items: "$ref": "#/components/schemas/cloud.loadbalancing.pool.Member" required: - members cloud.loadbalancing.pool.Member: type: object description: Member properties: address: description: IP address of the resource "$ref": "#/components/schemas/ip" id: type: string description: ID of the resource format: uuid readOnly: true name: type: string description: Name of the resource operatingStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerOperatingStatusEnum" description: Operating status of the resource readOnly: true protocolPort: type: integer description: Protocol port number for the resource provisioningStatus: allOf: - "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancerProvisioningStatusEnum" description: Provisioning status of the resource readOnly: true weight: type: integer description: Weight of a member determines the portion of requests or connections it services compared to the other members of the pool nullable: true required: - address - protocolPort cloud.loadbalancing.pool.MemberUpdate: type: object description: Parameters to update a pool member properties: name: type: string description: Name of the resource nullable: true weight: type: integer description: Weight of a member determines the portion of requests or connections it services compared to the other members of the pool nullable: true cloud.network.CreateGateway: type: object description: Input to create a gateway properties: model: description: Model of the gateway "$ref": "#/components/schemas/cloud.network.GatewayModelEnum" name: type: string description: Name of the gateway network: description: Information to create the network for the gateway "$ref": "#/components/schemas/cloud.network.CreateNetworkForGatewaySummary" required: - model - name - network cloud.network.CreateGatewaySummary: type: object description: Parameters to create a gateway from another resource creation properties: model: description: Model of the gateway "$ref": "#/components/schemas/cloud.network.GatewayModelEnum" name: type: string description: Gateway name required: - model - name cloud.network.CreateNetwork: type: object description: Parameters to create a network with a gateway properties: gateway: allOf: - "$ref": "#/components/schemas/cloud.network.CreateGatewaySummary" nullable: true name: type: string description: Network name subnet: "$ref": "#/components/schemas/cloud.network.CreateSubnetSummary" vlanId: type: integer description: VLAN id, between 1 and 4000 required: - name - subnet cloud.network.CreateNetworkForGatewaySummary: type: object description: Parameters to create a network from another resource creation properties: name: type: string description: Name of the network subnet: description: Subnet of the network "$ref": "#/components/schemas/cloud.network.CreateSubnetForGatewaySummary" vlanId: type: integer description: VLAN id, between 1 and 4000 required: - name - subnet cloud.network.CreateSubnetForGatewaySummary: type: object description: Parameters to create a subnet from another resource creation properties: cidr: description: Subnet range in CIDR notation "$ref": "#/components/schemas/ipBlock" enableDhcp: type: boolean description: Enable DHCP for the subnet ipVersion: type: integer description: IP version required: - cidr - enableDhcp - ipVersion cloud.network.CreateSubnetSummary: type: object description: Parameters to create a subnet from another resource creation properties: cidr: description: Subnet range in CIDR notation "$ref": "#/components/schemas/ipBlock" enableDhcp: type: boolean description: Enable DHCP for the subnet enableGatewayIp: type: boolean description: Set a gateway ip for the subnet ipVersion: type: integer description: IP version required: - cidr - enableDhcp - enableGatewayIp - ipVersion cloud.network.Gateway: type: object description: Gateway properties: externalInformation: allOf: - "$ref": "#/components/schemas/cloud.network.gateway.ExternalInformation" description: External information nullable: true readOnly: true id: type: string description: ID of the gateway format: uuid readOnly: true interfaces: type: array description: Interfaces list of the gateway items: "$ref": "#/components/schemas/cloud.network.gateway.Interface" readOnly: true model: allOf: - "$ref": "#/components/schemas/cloud.network.GatewayModelEnum" description: Model of the gateway readOnly: true name: type: string description: Name of the gateway readOnly: true region: type: string description: Gateway region readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.network.GatewayStatusEnum" description: Status of the gateway readOnly: true cloud.network.GatewayModelEnum: type: string description: GatewayModelEnum enum: - 2xl - 3xl - l - m - s - xl cloud.network.GatewayStatusEnum: type: string description: GatewayStatusEnum enum: - active - building - down - error cloud.network.IPPool: type: object description: IPPool properties: dhcp: type: boolean description: Enable DHCP readOnly: true end: allOf: - "$ref": "#/components/schemas/ip" description: 'Last IP for this region (eg: 192.168.1.24)' readOnly: true network: allOf: - "$ref": "#/components/schemas/ipBlock" description: 'Global network with cidr (eg: 192.168.1.0/24)' readOnly: true region: type: string description: Region where this subnet will be created readOnly: true start: allOf: - "$ref": "#/components/schemas/ip" description: 'First IP for this region (eg: 192.168.1.12)' readOnly: true cloud.network.Network: type: object description: Network properties: id: type: string description: Network id readOnly: true name: type: string description: Network name readOnly: true regions: type: array description: Details about private network in region items: "$ref": "#/components/schemas/cloud.network.NetworkRegion" readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.network.NetworkStatusEnum" description: Network status readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.network.NetworkTypeEnum" description: Network type nullable: true readOnly: true vlanId: type: integer description: Network VLAN id readOnly: true cloud.network.NetworkRegion: type: object description: NetworkRegion properties: openstackId: type: string description: Network id on openstack region nullable: true readOnly: true region: type: string description: Network region readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.network.NetworkRegionStatusEnum" description: Network region status readOnly: true cloud.network.NetworkRegionStatusEnum: type: string description: NetworkRegionStatusEnum enum: - ACTIVE - BUILDING cloud.network.NetworkStatusEnum: type: string description: NetworkStatusEnum enum: - ACTIVE - BUILDING - DELETING cloud.network.NetworkTypeEnum: type: string description: NetworkTypeEnum enum: - private - public cloud.network.NetworkVisibilityEnum: type: string description: NetworkVisibilityEnum enum: - private - public cloud.network.Subnet: type: object description: Subnet properties: cidr: allOf: - "$ref": "#/components/schemas/ipBlock" description: Subnet CIDR readOnly: true dhcpEnabled: type: boolean description: Is DHCP enabled for the subnet readOnly: true gatewayIp: allOf: - "$ref": "#/components/schemas/ip" description: Gateway IP in the subnet nullable: true readOnly: true id: type: string description: Subnet id readOnly: true ipPools: type: array description: List of ip pools allocated in subnet items: "$ref": "#/components/schemas/cloud.network.IPPool" readOnly: true cloud.network.UpdateGateway: type: object description: Input to update a gateway properties: model: description: Model of the gateway "$ref": "#/components/schemas/cloud.network.GatewayModelEnum" name: type: string description: Name of the gateway required: - model - name cloud.network.gateway.CreateInterface: type: object description: Input to create a new interface for a gateway properties: subnetId: type: string description: Subnet id to add format: uuid required: - subnetId cloud.network.gateway.ExternalInformation: type: object description: External information of the gateway properties: ips: type: array description: External ips of the gateway items: "$ref": "#/components/schemas/cloud.network.gateway.IpSubnet" readOnly: true networkId: type: string description: External network ID of the gateway format: uuid readOnly: true cloud.network.gateway.Interface: type: object description: Interface of the gateway properties: id: type: string description: ID of the interface format: uuid readOnly: true ip: allOf: - "$ref": "#/components/schemas/ip" description: IP of the interface readOnly: true networkId: type: string description: Network ID of the interface format: uuid readOnly: true subnetId: type: string description: Subnet ID of the interface format: uuid readOnly: true cloud.network.gateway.IpSubnet: type: object description: IP and subnet information properties: ip: allOf: - "$ref": "#/components/schemas/ip" description: External IP of the gateway readOnly: true subnetId: type: string description: Subnet ID of the ip format: uuid readOnly: true cloud.order.Order: type: object description: Cloud Order properties: date: type: string description: Order creation date format: date-time readOnly: true orderId: type: integer description: Order id readOnly: true planCode: type: string description: Order plan code readOnly: true serviceName: type: string description: Service created nullable: true readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.order.StatusEnum" readOnly: true cloud.order.StatusEnum: type: string description: Order status enum: - delivered - delivering - unknown - unpaid cloud.order.rule.Availability: type: object description: Public Cloud products availability properties: plans: type: array description: Plan availability items: "$ref": "#/components/schemas/cloud.order.rule.AvailabilityPlan" readOnly: true products: type: array description: Product availability items: "$ref": "#/components/schemas/cloud.order.rule.AvailabilityProduct" readOnly: true cloud.order.rule.AvailabilityPlan: type: object description: Public Cloud plan availability properties: code: type: string description: Plan code readOnly: true regions: type: array description: Plan is available on those regions items: type: string readOnly: true cloud.order.rule.AvailabilityProduct: type: object description: Public Cloud product availability properties: name: type: string description: Product name readOnly: true regions: type: array description: Product is available on those regions items: type: string readOnly: true cloud.order.rule.InstanceCategories: type: object description: Public Cloud instance categories properties: categories: type: array description: Instance categories items: "$ref": "#/components/schemas/cloud.order.rule.InstanceCategory" readOnly: true defaultCategory: type: string description: Default instance category name readOnly: true cloud.order.rule.InstanceCategory: type: object description: Public Cloud instance category properties: category: allOf: - "$ref": "#/components/schemas/cloud.order.rule.InstanceCategoryTypeEnum" description: Instance category name readOnly: true isNew: type: boolean description: Instance category is new nullable: true readOnly: true kinds: type: array description: Instance flavor matching patterns items: type: string readOnly: true title: type: string description: Instance category title readOnly: true cloud.order.rule.InstanceCategoryTypeEnum: type: string description: InstanceCategoryTypeEnum enum: - accelerated - balanced - baremetal - discovery - iops - ram - vps cloud.project.AllocationPool: type: object description: AllocationPool properties: end: allOf: - "$ref": "#/components/schemas/ip" description: 'Last IP for the pool (eg: 192.168.1.24)' readOnly: true start: allOf: - "$ref": "#/components/schemas/ip" description: 'First IP for the pool (eg: 192.168.1.12)' readOnly: true cloud.project.ApplicationLoadBalancer: type: object description: A load balancer to handle application workload properties: address: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.Address" description: Address to reach the load balancer readOnly: true configuration: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.ConfigurationVersion" description: Information about version of the configuration readOnly: true createdAt: type: string description: Creation date and time of the load balancer format: date-time readOnly: true description: type: string description: Description of the load balancer nullable: true egressAddress: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.Addresses" description: IPs used by the load balancer to contact backend's servers readOnly: true id: type: string description: ID of the load balancer format: uuid readOnly: true name: type: string description: Name of the load balancer nullable: true openstackRegion: type: string description: Openstack region where the load balancer is hosted readOnly: true region: type: string description: Region where the load balancer is hosted readOnly: true size: description: Size of the load balancer "$ref": "#/components/schemas/cloud.project.loadbalancer.SizeEnum" status: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.StatusEnum" description: Status of a load balancer readOnly: true cloud.project.ApplicationLoadBalancerCreation: type: object description: A load balancer to handle application workload properties: description: type: string description: Description of the load balancer nullable: true id: type: string description: ID of the load balancer format: uuid readOnly: true name: type: string description: Name of the load balancer nullable: true networking: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.NetworkingCreation" description: Networking definition nullable: true openstackRegion: type: string description: Openstack Region where the load balancer is hosted region: type: string description: Region where the load balancer is hosted size: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.SizeEnum" description: Size of the load balancer nullable: true required: - region cloud.project.Certificate: type: object description: A Certificate to use in your NFVs properties: expireAt: type: string description: Date after when the certificate is not valid format: date-time readOnly: true fingerprint: type: string description: Fingerprint of the cert (prefixed by hashing algorithm used) readOnly: true id: type: string description: Unique ID of the certificate format: uuid readOnly: true issuer: type: string description: Issue of the certificate (extract from certificate) readOnly: true kind: allOf: - "$ref": "#/components/schemas/cloud.project.CertificateKindEnum" description: Kind of certificate readOnly: true name: type: string description: Name of the certificate readOnly: true serialNumber: type: string description: Serial number of the certificate (extract from certificate) readOnly: true serverAlternativeNames: type: array description: List of SANs (extract from certificate) items: "$ref": "#/components/schemas/cloud.project.certificate.ServerAlternativeName" readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.CertificateStatusEnum" description: Certificate status, to quickly know it can safely be used readOnly: true subject: type: string description: Subject of the certificate (extract from certificate) readOnly: true validAt: type: string description: Date after when the certificate is valid format: date-time readOnly: true version: type: integer description: Version of certificate (incremented every time you push a new certificate with the same name) readOnly: true cloud.project.CertificateAdd: type: object description: Add a new certificate properties: import: allOf: - "$ref": "#/components/schemas/cloud.project.certificate.Import" description: Import an existing certificate nullable: true name: type: string description: Name of the certificate required: - name cloud.project.CertificateKindEnum: type: string description: Certificate kind enum: - IMPORTED cloud.project.CertificateStatusEnum: type: string description: Certificate status enum: - EXPIRED - NOT_YET_VALID - OK - REVOKED cloud.project.FloatingIp: type: object description: A floating ip properties: associatedEntity: allOf: - "$ref": "#/components/schemas/cloud.project.floatingIp.AssociatedEntity" description: Associated entity with the floating ip nullable: true readOnly: true id: type: string description: ID of the floating ip format: uuid readOnly: true ip: allOf: - "$ref": "#/components/schemas/ip" description: Value of the floating ip readOnly: true networkId: type: string description: ID of the network format: uuid readOnly: true region: type: string description: Floating ip region nullable: true readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.floatingIp.StatusEnum" description: Status of the floating ip readOnly: true cloud.project.LoadBalancer: type: object description: A load balancer to handle workload properties: address: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.Address" description: Address to reach the load balancer readOnly: true configuration: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.ConfigurationVersion" description: Information about version of the configuration readOnly: true createdAt: type: string description: Creation date and time of the load balancer format: date-time readOnly: true description: type: string description: Description of the load balancer nullable: true egressAddress: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.Addresses" description: IPs used by the load balancer to contact backend's servers readOnly: true id: type: string description: ID of the load balancer format: uuid readOnly: true name: type: string description: Name of the load balancer nullable: true networking: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.Networking" description: Networking definition readOnly: true openstackRegion: type: string description: Openstack region where the load balancer is hosted readOnly: true region: type: string description: Region where the load balancer is hosted readOnly: true size: description: Size of the load balancer "$ref": "#/components/schemas/cloud.project.loadbalancer.SizeEnum" status: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.StatusEnum" description: Status of a load balancer readOnly: true cloud.project.LoadBalancerCreation: type: object description: A load balancer to handle workload properties: description: type: string description: Description of the load balancer nullable: true id: type: string description: ID of the load balancer format: uuid readOnly: true name: type: string description: Name of the load balancer nullable: true networking: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.NetworkingCreation" description: Networking definition nullable: true openstackRegion: type: string description: Openstack Region where the load balancer is hosted region: type: string description: Region where the load balancer is hosted size: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.SizeEnum" description: Size of the load balancer nullable: true required: - region cloud.project.Network: type: object description: Network properties: id: type: string description: Network id readOnly: true name: type: string description: Network name readOnly: true region: type: string description: Network region nullable: true readOnly: true visibility: allOf: - "$ref": "#/components/schemas/cloud.network.NetworkVisibilityEnum" description: Network visibility readOnly: true vlanId: type: integer description: Network VLAN id nullable: true readOnly: true cloud.project.NetworkLoadBalancer: type: object description: A network load balancer for TCP/UDP workloads properties: address: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.Address" description: Address to reach the load balancer readOnly: true configuration: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.ConfigurationVersion" description: Information about version of the configuration readOnly: true createdAt: type: string description: Creation date and time of the load balancer format: date-time readOnly: true description: type: string description: Description of the load balancer nullable: true egressAddress: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.Addresses" description: IPs used by the load balancer to contact backend's servers readOnly: true id: type: string description: ID of the load balancer format: uuid readOnly: true name: type: string description: Name of the load balancer nullable: true openstackRegion: type: string description: Openstack region where the load balancer is hosted readOnly: true region: type: string description: Region where the load balancer is hosted readOnly: true size: description: Size of the load balancer "$ref": "#/components/schemas/cloud.project.loadbalancer.SizeEnum" status: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.StatusEnum" description: Status of a load balancer readOnly: true cloud.project.NetworkLoadBalancerCreation: type: object description: A network load balancer for TCP/UDP workloads properties: description: type: string description: Description of the load balancer nullable: true id: type: string description: ID of the load balancer format: uuid readOnly: true name: type: string description: Name of the load balancer nullable: true networking: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.NetworkingCreation" description: Networking definition nullable: true openstackRegion: type: string description: Openstack Region where the load balancer is hosted region: type: string description: Region where the load balancer is hosted size: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.SizeEnum" description: Size of the load balancer nullable: true required: - region cloud.project.ProjectStatus: type: string description: Possible values for project status enum: - creating - deleted - deleting - ok - suspended cloud.project.ProjectStatusEnum: type: string description: Possible values for project status enum: - creating - deleted - deleting - ok - suspended cloud.project.Subnet: type: object description: Subnet properties: allocationPools: type: array description: List of ip pools allocated in subnet items: "$ref": "#/components/schemas/cloud.project.AllocationPool" readOnly: true cidr: allOf: - "$ref": "#/components/schemas/ipBlock" description: Subnet CIDR readOnly: true dhcpEnabled: type: boolean description: If DHCP is enabled on subnet readOnly: true gatewayIp: allOf: - "$ref": "#/components/schemas/ip" description: Gateway IP nullable: true readOnly: true id: type: string description: Subnet id readOnly: true ipVersion: type: integer description: IP Version (4 or 6) readOnly: true name: type: string description: Subnet name readOnly: true cloud.project.certificate.Import: type: object description: Import external certificate properties: cert: type: string description: PEM encoded certificate chain: type: string description: Optional PEM encoded certificate chain nullable: true key: type: string description: PEM encoded certificate private key format: password required: - cert - key cloud.project.certificate.ServerAlternativeName: type: object description: Certificate SAN properties: kind: allOf: - "$ref": "#/components/schemas/cloud.project.certificate.ServerAlternativeNameKindEnum" description: SAN kind readOnly: true name: type: string description: Name of the given kind readOnly: true cloud.project.certificate.ServerAlternativeNameKindEnum: type: string description: SAN kind enum: - DNS - EMAIL - IP - URI cloud.project.database.Availability: type: object description: Availability of databases engines on cloud projects properties: backup: allOf: - "$ref": "#/components/schemas/cloud.project.database.BackupTypeEnum" description: 'Defines the type of backup. DEPRECATED: use backups.enable' readOnly: true backupRetentionDays: type: integer description: 'Backup retention time of the availability in days. DEPRECATED: use backups.retentionDays' readOnly: true backups: allOf: - "$ref": "#/components/schemas/cloud.project.database.availability.Backups" description: Defines backups strategy for the availability readOnly: true category: allOf: - "$ref": "#/components/schemas/cloud.project.database.engine.CategoryEnum" description: Category of the engine readOnly: true default: type: boolean description: Whether this availability can be used by default readOnly: true endOfLife: type: string description: 'End of life of the product. DEPRECATED: use lifecycle.endOfLife' nullable: true format: date readOnly: true engine: type: string description: Database engine name readOnly: true flavor: type: string description: 'Flavor name. DEPRECATED: use specifications.flavor' readOnly: true lifecycle: allOf: - "$ref": "#/components/schemas/cloud.project.database.availability.Lifecycle" description: Defines the lifecycle of the availability readOnly: true maxDiskSize: type: integer description: 'Maximum possible disk size in GB. DEPRECATED: use specifications.storage.maximum' readOnly: true maxNodeNumber: type: integer description: 'Maximum nodes of the cluster. DEPRECATED: use specifications.nodes.maximum' readOnly: true minDiskSize: type: integer description: 'Minimum possible disk size in GB. DEPRECATED: use specifications.storage.minimum' readOnly: true minNodeNumber: type: integer description: 'Minimum nodes of the cluster. DEPRECATED: use specifications.nodes.minimum' readOnly: true network: allOf: - "$ref": "#/components/schemas/cloud.project.database.NetworkTypeEnum" description: 'Type of network. DEPRECATED: use specifications.network' readOnly: true plan: type: string description: Plan name readOnly: true region: type: string description: Region name readOnly: true specifications: allOf: - "$ref": "#/components/schemas/cloud.project.database.availability.Specifications" description: Defines the technical specifications of the availability readOnly: true startDate: type: string description: 'Date of the release of the product. DEPRECATED: use lifecycle.startDate' format: date readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.availability.StatusEnum" description: 'Status of the availability. DEPRECATED: use lifecycle.status' readOnly: true stepDiskSize: type: integer description: 'Flex disk size step in GB. DEPRECATED: use specifications.storage.step' readOnly: true upstreamEndOfLife: type: string description: 'End of life of the upstream product. DEPRECATED: use lifecycle' nullable: true format: date readOnly: true version: type: string description: Version name readOnly: true cloud.project.database.Backup: type: object description: Cloud database backup definition properties: createdAt: type: string description: Date of the creation of the backup format: date-time readOnly: true description: type: string description: Description of the backup readOnly: true id: type: string description: Backup ID format: uuid readOnly: true region: type: string description: 'Region where the backup is stored. DEPRECATED: use regions' readOnly: true regions: type: array description: Regions where the backup are stored items: "$ref": "#/components/schemas/cloud.project.database.backup.Region" readOnly: true size: allOf: - "$ref": "#/components/schemas/complexType.UnitAndValue_long" description: Size of the backup readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the backup readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.project.database.BackupTypeEnum" description: Type of backup readOnly: true cloud.project.database.BackupTypeEnum: type: string description: Type of backup for the cluster enum: - automatic - manual - none - pitr - snapshot cloud.project.database.Capabilities: type: object description: Capabilities available for the databases engines on cloud projects properties: disks: type: array description: Disks available items: type: string readOnly: true engines: type: array description: Database engines available items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Engine" readOnly: true flavors: type: array description: Flavors available items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Flavor" readOnly: true options: type: array description: Options available items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Option" readOnly: true plans: type: array description: Plans available items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Plan" readOnly: true regions: type: array description: Regions available items: type: string readOnly: true cloud.project.database.EngineEnum: type: string description: Possible names of the engines enum: - cassandra - grafana - kafka - kafkaConnect - kafkaMirrorMaker - m3aggregator - m3db - mongodb - mysql - opensearch - postgresql - redis cloud.project.database.IpRestriction: type: object description: Ip Restriction definition for cloud project databases (DEPRECATED) properties: description: type: string description: Description of the ip restriction ip: allOf: - "$ref": "#/components/schemas/ipBlock" description: Whitelisted IP readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the ip restriction readOnly: true cloud.project.database.IpRestrictionCreation: type: object description: Ip Restriction creation definition for cloud project databases (DEPRECATED) properties: description: type: string description: Description of the ip restriction ip: description: Whitelisted IP "$ref": "#/components/schemas/ipBlock" cloud.project.database.NetworkTypeEnum: type: string description: Type of network in which the databases cluster are enum: - private - public cloud.project.database.Service: type: object description: Cloud database service definition properties: backupTime: description: 'Time on which backups start every day. DEPRECATED: use backups.time' "$ref": "#/components/schemas/time" backups: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.Backup" description: Information related to the backups, null if the engine does not support backups nullable: true capabilities: type: object description: Capabilities of the services additionalProperties: "$ref": "#/components/schemas/cloud.project.database.service.CapabilityActions" readOnly: true category: allOf: - "$ref": "#/components/schemas/cloud.project.database.engine.CategoryEnum" description: Category of the engine readOnly: true createdAt: type: string description: Date of the creation of the cluster format: date-time readOnly: true description: type: string description: Description of the cluster disk: description: 'Disk attributes of the cluster. DEPRECATED: use storage' "$ref": "#/components/schemas/cloud.project.database.service.Disk" endpoints: type: array description: List of all endpoints of the service items: "$ref": "#/components/schemas/cloud.project.database.service.Endpoint" readOnly: true engine: allOf: - "$ref": "#/components/schemas/cloud.project.database.EngineEnum" description: Name of the engine of the service readOnly: true flavor: type: string description: The VM flavor used for this cluster id: type: string description: Service ID format: uuid readOnly: true ipRestrictions: type: array description: IP Blocks authorized to access to the cluster items: "$ref": "#/components/schemas/cloud.project.database.service.IpRestriction" maintenanceTime: description: Time on which maintenances can start every day "$ref": "#/components/schemas/time" networkId: type: string description: Private network ID in which the cluster is nullable: true format: uuid readOnly: true networkType: allOf: - "$ref": "#/components/schemas/cloud.project.database.NetworkTypeEnum" description: Type of network of the cluster readOnly: true nodeNumber: type: integer description: 'Number of nodes in the cluster. DEPRECATED: use nodes' nodes: type: array description: Nodes of the cluster items: "$ref": "#/components/schemas/cloud.project.database.service.Node" readOnly: true plan: type: string description: Plan of the cluster region: type: string description: Region of the cluster nullable: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the cluster readOnly: true storage: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.Storage" description: Storage attributes of the cluster nullable: true subnetId: type: string description: Private subnet ID in which the cluster is nullable: true format: uuid readOnly: true version: type: string description: Version of the engine deployed on the cluster cloud.project.database.ServiceCreation: type: object description: Cloud databases cluster definition properties: backup: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.creation.BackupFork" description: 'Backup from which the new service is created. DEPRECATED: use forkFrom' nullable: true backupTime: allOf: - "$ref": "#/components/schemas/time" description: 'Time on which backups start every day. DEPRECATED: use backups.time' nullable: true backups: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.Backup" description: Information related to the backups, null if the engine does not support backups nullable: true description: type: string description: Description of the cluster disk: description: Disk attributes of the cluster "$ref": "#/components/schemas/cloud.project.database.service.Disk" forkFrom: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.creation.ForkFrom" description: Backup from which the new service is created nullable: true ipRestrictions: type: array description: IP Blocks authorized to access to the cluster items: "$ref": "#/components/schemas/cloud.project.database.service.IpRestriction" maintenanceTime: allOf: - "$ref": "#/components/schemas/time" description: Time on which maintenances can start every day nullable: true networkId: type: string description: Private network ID in which the cluster is nullable: true format: uuid nodesList: type: array description: List of nodes in the cluster, not compatible with nodesPattern nullable: true items: "$ref": "#/components/schemas/cloud.project.database.service.NodeCreation" nodesPattern: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.NodePattern" description: Pattern definition of the nodes in the cluster, not compatible with nodesList nullable: true plan: type: string description: Plan of the cluster subnetId: type: string description: Private subnet ID in which the cluster is nullable: true format: uuid version: type: string description: Version of the engine deployed on the cluster cloud.project.database.StatusEnum: type: string description: Possible state of the job enum: - CREATING - DELETING - ERROR - ERROR_INCONSISTENT_SPEC - LOCKED - LOCKED_PENDING - LOCKED_UPDATING - PENDING - READY - SHELVED - UPDATING cloud.project.database.TemporaryWriteDeadline: type: object description: Cloud databases temporary write deadline definition properties: until: type: string description: Date on which the temporary write permissions would be lifted format: date-time readOnly: true cloud.project.database.TypeEnum: type: string description: Type of data returned in the capabilities options enum: - boolean - double - duration - long - string cloud.project.database.availability.ActionEnum: type: string description: Possible action to restrict availabilities enum: - fork - read - update cloud.project.database.availability.Backups: type: object description: Backups availability of databases engines on cloud projects properties: available: type: boolean description: Defines whether the backups are available for this offer readOnly: true retentionDays: type: integer description: Number of retention days for the backups nullable: true readOnly: true cloud.project.database.availability.Lifecycle: type: object description: Availability of databases engines on cloud projects properties: endOfLife: type: string description: End of life of the product nullable: true format: date readOnly: true endOfSale: type: string description: End of sale of the product nullable: true format: date readOnly: true startDate: type: string description: Date of the release of the product format: date readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.availability.StatusEnum" description: Status of the availability readOnly: true cloud.project.database.availability.Specifications: type: object description: Specifications of the availability of databases engines on cloud projects properties: flavor: type: string description: Flavor name readOnly: true network: allOf: - "$ref": "#/components/schemas/cloud.project.database.NetworkTypeEnum" description: Type of network readOnly: true nodes: allOf: - "$ref": "#/components/schemas/cloud.project.database.availability.specifications.Nodes" description: Specification of the nodes readOnly: true storage: allOf: - "$ref": "#/components/schemas/cloud.project.database.availability.specifications.Storage" description: Specification of the storage nullable: true readOnly: true cloud.project.database.availability.StatusEnum: type: string description: Possible status for the availability enum: - BETA - DEPRECATED - END_OF_LIFE - END_OF_SALE - STABLE - UNAVAILABLE cloud.project.database.availability.TargetEnum: type: string description: Possible target to restrict availabilities enum: - flavor - plan - self - version cloud.project.database.availability.specifications.Nodes: type: object description: Specifications of the nodes for availabilities of databases engines on cloud projects properties: maximum: type: integer description: Maximum number of nodes of the availability readOnly: true minimum: type: integer description: Minimum number of nodes of the availability readOnly: true cloud.project.database.availability.specifications.Storage: type: object description: Specifications of the storage for availabilities of databases engines on cloud projects properties: maximum: allOf: - "$ref": "#/components/schemas/complexType.UnitAndValue_long" description: Maximum storage of the availability readOnly: true minimum: allOf: - "$ref": "#/components/schemas/complexType.UnitAndValue_long" description: Minimum storage of the availability readOnly: true step: allOf: - "$ref": "#/components/schemas/complexType.UnitAndValue_long" description: Memory step that can be added between minimum and maximum nullable: true readOnly: true cloud.project.database.backup.Region: type: object description: Cloud database backup region definition properties: name: type: string description: Name of the region where the backup is stored readOnly: true cloud.project.database.capabilities.Engine: type: object description: Specific database engine capability properties: category: allOf: - "$ref": "#/components/schemas/cloud.project.database.engine.CategoryEnum" description: Category of the engine readOnly: true defaultVersion: type: string description: Default version used for the engine readOnly: true description: type: string description: Description of the engine readOnly: true name: type: string description: Engine name readOnly: true sslModes: type: array description: SSL modes for this engine items: type: string readOnly: true storage: allOf: - "$ref": "#/components/schemas/cloud.project.database.capabilities.engine.storage.StrategyEnum" description: Storage strategy of the engine readOnly: true versions: type: array description: Versions available for this engine items: type: string readOnly: true cloud.project.database.capabilities.Flavor: type: object description: Cloud Database flavor definition properties: core: type: integer description: 'Flavor core number. DEPRECATED: use specifications.core' readOnly: true lifecycle: allOf: - "$ref": "#/components/schemas/cloud.project.database.availability.Lifecycle" description: Defines the lifecycle of the flavor readOnly: true memory: type: integer description: 'Flavor ram size in GB. DEPRECATED: use specifications.memory' readOnly: true name: type: string description: Name of the flavor readOnly: true order: type: integer description: Display order readOnly: true specifications: allOf: - "$ref": "#/components/schemas/cloud.project.database.capabilities.flavor.Specifications" description: Technical specifications of the flavor readOnly: true storage: type: integer description: 'Flavor disk size in GB. DEPRECATED: use specifications.storage' readOnly: true tags: type: array description: Display tags items: type: string readOnly: true cloud.project.database.capabilities.Integration: type: object description: Integration capability between database engines properties: destinationEngine: allOf: - "$ref": "#/components/schemas/cloud.project.database.EngineEnum" description: Destination engine for the integration readOnly: true parameters: type: array description: Parameters for the integration capability nullable: true items: "$ref": "#/components/schemas/cloud.project.database.capabilities.integration.Parameter" readOnly: true sourceEngine: allOf: - "$ref": "#/components/schemas/cloud.project.database.EngineEnum" description: Source engine for the integration readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.integration.TypeEnum" description: Type of the integration readOnly: true cloud.project.database.capabilities.Option: type: object description: Cloud Database option definition properties: name: type: string description: Name of the option readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.project.database.TypeEnum" description: Type of the option readOnly: true cloud.project.database.capabilities.Plan: type: object description: Cloud Database plan definition properties: backupRetention: type: string description: Automatic backup retention duration format: duration readOnly: true description: type: string description: Description of the plan readOnly: true lifecycle: allOf: - "$ref": "#/components/schemas/cloud.project.database.availability.Lifecycle" description: Defines the lifecycle of the availability readOnly: true name: type: string description: Name of the plan readOnly: true order: type: integer description: Display order readOnly: true tags: type: array description: Display tags items: type: string readOnly: true cloud.project.database.capabilities.advancedConfiguration.Property: type: object description: Specific database engine capability properties: description: type: string description: Description of the property readOnly: true maximum: type: number description: Maximum value for the property if numeric and applicable nullable: true readOnly: true minimum: type: number description: Minimum value for the property if numeric and applicable nullable: true readOnly: true name: type: string description: Property name readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.project.database.capabilities.advancedConfiguration.property.TypeEnum" description: Data type of the property readOnly: true values: type: array description: Possible values for the property if string and applicable nullable: true items: type: string readOnly: true cloud.project.database.capabilities.advancedConfiguration.property.TypeEnum: type: string description: Possible type of the advanced configuration properties enum: - boolean - double - long - string cloud.project.database.capabilities.engine.storage.StrategyEnum: type: string description: Possible storage strategy for an engine enum: - distributed - n/a - replicated cloud.project.database.capabilities.flavor.Specifications: type: object description: Cloud Database flavor specifications definition properties: core: type: integer description: Flavor core number readOnly: true memory: allOf: - "$ref": "#/components/schemas/complexType.UnitAndValue_long" description: Flavor ram size readOnly: true storage: allOf: - "$ref": "#/components/schemas/complexType.UnitAndValue_long" description: Flavor disk size readOnly: true cloud.project.database.capabilities.integration.Parameter: type: object description: Integration capability parameter properties: name: type: string description: Name of the integration parameter readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.project.database.capabilities.integration.parameter.TypeEnum" description: Type of the integration parameter readOnly: true cloud.project.database.capabilities.integration.parameter.TypeEnum: type: string description: Possible type of an integration capability parameter enum: - integer - string cloud.project.database.engine.CategoryEnum: type: string description: Different categories of engines enum: - analysis - operational - streaming cloud.project.database.kafka.Permissions: type: object description: Cloud databases kafka permissions definition properties: names: type: array description: Names of the topic permissions (DEPRECATED) items: type: string readOnly: true schemaRegistry: type: array description: Names of the schema registry permissions items: type: string readOnly: true topic: type: array description: Names of the topic permissions items: type: string readOnly: true cloud.project.database.kafka.SchemaRegistryAcl: type: object description: Cloud databases kafka schema registry acl definition properties: id: type: string description: Acl ID format: uuid readOnly: true permission: type: string description: Permission to give to this username on this resource. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions resource: type: string description: Resource affected by this acl username: type: string description: Username affected by this acl required: - permission - resource - username cloud.project.database.kafka.Service: type: object description: Cloud database kafka service definition properties: backupTime: description: Time on which backups start every day "$ref": "#/components/schemas/time" capabilities: type: object description: Capabilities of the services additionalProperties: "$ref": "#/components/schemas/cloud.project.database.service.CapabilityActions" readOnly: true category: allOf: - "$ref": "#/components/schemas/cloud.project.database.engine.CategoryEnum" description: Category of the engine readOnly: true createdAt: type: string description: Date of the creation of the cluster format: date-time readOnly: true description: type: string description: Description of the cluster disk: description: 'Disk attributes of the cluster. DEPRECATED: use storage' "$ref": "#/components/schemas/cloud.project.database.service.Disk" endpoints: type: array description: List of all endpoints of the service items: "$ref": "#/components/schemas/cloud.project.database.service.Endpoint" readOnly: true engine: allOf: - "$ref": "#/components/schemas/cloud.project.database.EngineEnum" description: Name of the engine of the service readOnly: true flavor: type: string description: The VM flavor used for this cluster id: type: string description: Service ID format: uuid readOnly: true ipRestrictions: type: array description: IP Blocks authorized to access to the cluster items: "$ref": "#/components/schemas/cloud.project.database.service.IpRestriction" maintenanceTime: description: Time on which maintenances can start every day "$ref": "#/components/schemas/time" networkId: type: string description: Private network ID in which the cluster is nullable: true format: uuid readOnly: true networkType: allOf: - "$ref": "#/components/schemas/cloud.project.database.NetworkTypeEnum" description: Type of network of the cluster readOnly: true nodeNumber: type: integer description: 'Number of nodes in the cluster. DEPRECATED: useNodes' nodes: type: array description: Nodes of the cluster items: "$ref": "#/components/schemas/cloud.project.database.service.Node" readOnly: true plan: type: string description: Plan of the cluster restApi: type: boolean description: Defines whether the REST API is enabled on the cluster schemaRegistry: type: boolean description: Defines whether the schema registry is enabled on the cluster status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the cluster readOnly: true storage: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.Storage" description: Storage attributes of the cluster nullable: true subnetId: type: string description: Private subnet ID in which the cluster is nullable: true format: uuid readOnly: true version: type: string description: Version of the engine deployed on the cluster cloud.project.database.kafka.Topic: type: object description: Cloud database kafka topic definition properties: id: type: string description: Topic ID format: uuid readOnly: true minInsyncReplicas: type: integer description: Minimum insync replica accepted for this topic name: type: string description: Name of the topic readOnly: true partitions: type: integer description: Number of partitions for this topic replication: type: integer description: Number of replication for this topic retentionBytes: type: integer description: Number of bytes for the retention of the data for this topic retentionHours: type: integer description: Number of hours for the retention of the data for this topic cloud.project.database.kafka.TopicAcl: type: object description: Cloud databases kafka topic acl definition properties: id: type: string description: Acl ID format: uuid readOnly: true permission: type: string description: Permission to give to this username on this topic. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions topic: type: string description: Topic affected by this acl username: type: string description: Username affected by this acl required: - permission - topic - username cloud.project.database.kafka.TopicCreation: type: object description: Cloud database kafka topic creation definition properties: id: type: string description: Topic ID format: uuid readOnly: true minInsyncReplicas: type: integer description: Minimum insync replica accepted for this topic name: type: string description: Name of the topic partitions: type: integer description: Number of partitions for this topic replication: type: integer description: Number of replication for this topic retentionBytes: type: integer description: Number of bytes for the retention of the data for this topic retentionHours: type: integer description: Number of hours for the retention of the data for this topic required: - name cloud.project.database.kafka.user.Access: type: object description: Cloud databases kafka user access definition properties: cert: type: string description: User cert readOnly: true key: type: string description: User key for the cert format: password readOnly: true cloud.project.database.kafkaConnect.Connector: type: object description: KafkaConnect connector definition properties: configuration: type: object description: Configuration of the connector additionalProperties: type: string connectorId: type: string description: Connector capability ID format: uuid readOnly: true id: type: string description: Connector ID format: uuid readOnly: true name: type: string description: Name of the connector readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.connector.StatusEnum" description: Status of the connector readOnly: true required: - configuration cloud.project.database.kafkaConnect.ConnectorCreation: type: object description: KafkaConnect connector definition properties: configuration: type: object description: Configuration of the connector additionalProperties: type: string connectorId: type: string description: Connector capability ID format: uuid name: type: string description: Name of the connector required: - configuration - connectorId - name cloud.project.database.kafkaConnect.capabilities.Connector: type: object description: KafkaConnect connector capability definition properties: author: type: string description: Name of the connector's author readOnly: true documentationUrl: type: string description: URL of the official documentation of the connector readOnly: true id: type: string description: Connector ID format: uuid readOnly: true latest: type: boolean description: Defines whether this connector and version is the latest available readOnly: true name: type: string description: Name of the connector readOnly: true preview: type: boolean description: Defines whether the connector is in preview readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.capabilities.connector.TypeEnum" description: Type of connector readOnly: true version: type: string description: Version of the connector readOnly: true cloud.project.database.kafkaConnect.capabilities.connector.Transform: type: object description: KafkaConnect connector transform definition properties: description: type: string description: Description of the transform readOnly: true displayName: type: string description: Pretty name of the transform readOnly: true name: type: string description: Name of the transform readOnly: true required: type: boolean description: Defines whether the transform is required readOnly: true transformType: type: string description: Transform type this transform relates to readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.connector.property.TypeEnum" description: Type of data of the transform readOnly: true values: type: array description: Possible values for the transform if applicable nullable: true items: type: string readOnly: true cloud.project.database.kafkaConnect.capabilities.connector.TypeEnum: type: string description: Possible types for the kafka connectors enum: - sink - source cloud.project.database.kafkaConnect.capabilities.connector.configuration.Property: type: object description: KafkaConnect connector config property definition properties: defaultValue: type: string description: Defines the default value is exists nullable: true readOnly: true description: type: string description: Description of the property readOnly: true displayName: type: string description: Pretty name of the property readOnly: true group: type: string description: Group to which belongs the property readOnly: true importance: allOf: - "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.capabilities.connector.property.ImportanceEnum" description: Importance of the property readOnly: true name: type: string description: Name of the property readOnly: true required: type: boolean description: Defines whether the property is required readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.connector.property.TypeEnum" description: Type of data of the property readOnly: true values: type: array description: Possible values for the property if string and applicable nullable: true items: type: string readOnly: true cloud.project.database.kafkaConnect.capabilities.connector.property.ImportanceEnum: type: string description: Possible importance for the kafka connectors properties enum: - high - low - medium cloud.project.database.kafkaConnect.connector.StatusEnum: type: string description: Possible state of connector enum: - CREATING - FAILED - PAUSED - RUNNING - UNASSIGNED cloud.project.database.kafkaConnect.connector.Task: type: object description: KafkaConnect connector definition properties: id: type: integer description: Task ID readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.connector.task.StatusEnum" description: Status of the task readOnly: true trace: type: string description: Trace of the task readOnly: true cloud.project.database.kafkaConnect.connector.property.TypeEnum: type: string description: Possible types for the kafka connectors properties enum: - boolean - class - double - int16 - int32 - int64 - list - password - string - transform cloud.project.database.kafkaConnect.connector.task.StatusEnum: type: string description: Possible state of connector task enum: - FAILED - PAUSED - RUNNING cloud.project.database.m3db.Namespace: type: object description: M3db Namespace definition properties: id: type: string description: Namespace ID format: uuid readOnly: true name: type: string description: Name of the namespace readOnly: true resolution: type: string description: Resolution for an aggregated namespace nullable: true format: duration retention: description: Retention configuration "$ref": "#/components/schemas/cloud.project.database.m3db.namespace.Retention" snapshotEnabled: type: boolean description: Defines whether M3db will create snapshot files for this namespace type: allOf: - "$ref": "#/components/schemas/cloud.project.database.m3db.namespace.TypeEnum" description: Type of namespace readOnly: true writesToCommitLogEnabled: type: boolean description: Defines whether M3db will include writes to this namespace in the commit log cloud.project.database.m3db.NamespaceCreation: type: object description: M3db Namespace creation definition properties: id: type: string description: Namespace ID format: uuid readOnly: true name: type: string description: Name of the namespace resolution: type: string description: Resolution for an aggregated namespace format: duration retention: description: Retention configuration "$ref": "#/components/schemas/cloud.project.database.m3db.namespace.Retention" snapshotEnabled: type: boolean description: Defines whether M3db will create snapshot files for this namespace type: description: Type of namespace "$ref": "#/components/schemas/cloud.project.database.m3db.namespace.TypeEnum" writesToCommitLogEnabled: type: boolean description: Defines whether M3db will include writes to this namespace in the commit log required: - name - type cloud.project.database.m3db.User: type: object description: M3db User definition properties: createdAt: type: string description: Date of the creation of the user format: date-time readOnly: true group: type: string description: Group of the user id: type: string description: User ID format: uuid readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the user readOnly: true username: type: string description: Name of the user readOnly: true cloud.project.database.m3db.UserCreation: type: object description: User creation definition properties: group: type: string description: Group of the user name: type: string description: Name of the user required: - name cloud.project.database.m3db.UserWithPassword: type: object description: M3db User definition properties: createdAt: type: string description: Date of the creation of the user format: date-time readOnly: true group: type: string description: Group of the user readOnly: true id: type: string description: User ID format: uuid readOnly: true password: type: string description: Password of the user format: password readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the user readOnly: true username: type: string description: Name of the user readOnly: true cloud.project.database.m3db.namespace.Retention: type: object description: M3db namespace retention definition properties: blockDataExpirationDuration: type: string description: Controls how long we wait before expiring stale data nullable: true format: duration blockSizeDuration: type: string description: Controls how long to keep a block in memory before flushing to a fileset on disk nullable: true format: duration bufferFutureDuration: type: string description: Controls how far into the future writes to the namespace will be accepted nullable: true format: duration bufferPastDuration: type: string description: Controls how far into the past writes to the namespace will be accepted nullable: true format: duration periodDuration: type: string description: Controls the duration of time that M3DB will retain data for the namespace format: duration required: - periodDuration cloud.project.database.m3db.namespace.TypeEnum: type: string description: Possible type of the service integration enum: - aggregated - unaggregated cloud.project.database.mysql.QueryStatistics: type: object description: Cloud database mysql query statistics response body definition properties: queries: type: array description: Statistics of the queries items: "$ref": "#/components/schemas/cloud.project.database.mysql.querystatistics.Query" readOnly: true cloud.project.database.mysql.querystatistics.Query: type: object description: Cloud database mysql single query statistic definition properties: avgTimerWait: type: number description: Average wait time of the summarized timed events, in milliseconds readOnly: true countStar: type: integer description: Number of summarized events. This value includes all events, whether timed or nontimed readOnly: true digest: type: string description: Digest of the summarized events readOnly: true digestText: type: string description: Text of the summarized digest events readOnly: true firstSeen: type: string description: First appearance of the events format: date-time readOnly: true lastSeen: type: string description: Last appearance of the events format: date-time readOnly: true maxTimerWait: type: number description: Maximum wait time of the summarized timed events, in milliseconds readOnly: true minTimerWait: type: number description: Mininum wait time of the summarized timed events, in milliseconds readOnly: true quantile95: type: integer description: 95th percentile of the statement latency, in picoseconds readOnly: true quantile99: type: integer description: 99th percentile of the statement latency, in picoseconds readOnly: true quantile999: type: integer description: 99.9th percentile of the statement latency, in picoseconds readOnly: true querySampleSeen: type: string description: Datetime when the querySampleText column was seen format: date-time readOnly: true querySampleText: type: string description: Sample SQL statement that produces the digest value in the row readOnly: true querySampleTimerWait: type: number description: Wait time for the sample statement in the querySampleText column, in milliseconds readOnly: true schemaName: type: string description: SchemaName of the summarized events readOnly: true sumCreatedTmpDiskTables: type: integer description: Number of internal on-disk temporary tables created readOnly: true sumCreatedTmpTables: type: integer description: Number of internal temporary tables created readOnly: true sumErrors: type: integer description: Number of errors readOnly: true sumLockTime: type: number description: Sum of lock time of the summarized timed events, in milliseconds readOnly: true sumNoGoodIndexUsed: type: integer description: Sum of not good indexes of the summarized timed events readOnly: true sumNoIndexUsed: type: integer description: Sum of no indexes of the summarized timed events readOnly: true sumRowsAffected: type: integer description: Sum of rows affected of the summarized timed events readOnly: true sumRowsExamined: type: integer description: Sum of rows examined of the summarized timed events readOnly: true sumRowsSent: type: integer description: Sum of rows sent of the summarized timed events readOnly: true sumSelectFullJoin: type: integer description: Sum of select full join of the summarized timed events readOnly: true sumSelectFullRangeJoin: type: integer description: Sum of select full range join of the summarized timed events readOnly: true sumSelectRange: type: integer description: Sum of select range of the summarized timed events readOnly: true sumSelectRangeCheck: type: integer description: Sum of select range check of the summarized timed events readOnly: true sumSelectScan: type: integer description: Sum of select scan of the summarized timed events readOnly: true sumSortMergePasses: type: integer description: Sum of sorted merge passes of the summarized timed events readOnly: true sumSortRange: type: integer description: Sum of sorted range of the summarized timed events readOnly: true sumSortRows: type: integer description: Sum of sorted rows of the summarized timed events readOnly: true sumSortScan: type: integer description: Sum of sort scan of the summarized timed events readOnly: true sumTimerWait: type: number description: Sum of wait time of the summarized timed events, in milliseconds readOnly: true sumWarnings: type: integer description: Number of warnings readOnly: true cloud.project.database.opensearch.Index: type: object description: Cloud database opensearch index definition properties: createdAt: type: string description: Date of the creation of the index format: date-time readOnly: true documents: type: integer description: Number of documents hold by the index readOnly: true id: type: string description: Index ID format: uuid readOnly: true name: type: string description: Name of the index readOnly: true replicasNumber: type: integer description: Number of replicas of the index readOnly: true shardsNumber: type: integer description: Number of shards of the index readOnly: true size: type: integer description: Size of the index readOnly: true cloud.project.database.opensearch.Pattern: type: object description: Cloud database opensearch pattern definition properties: id: type: string description: Pattern ID format: uuid readOnly: true maxIndexCount: type: integer description: Maximum number of index for this pattern pattern: type: string description: Pattern format required: - pattern cloud.project.database.opensearch.Permissions: type: object description: Cloud database opensearch permissions definition properties: names: type: array description: Possible values for the permissions items: type: string readOnly: true cloud.project.database.opensearch.Service: type: object description: Cloud database opensearch service definition properties: aclsEnabled: type: boolean description: Defines whether the acls are enabled on the cluster backupTime: description: 'Time on which backups start every day. DEPRECATED: use backups.time' "$ref": "#/components/schemas/time" backups: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.Backup" description: Information related to the backups, null if the engine does not support backups nullable: true capabilities: type: object description: Capabilities of the services additionalProperties: "$ref": "#/components/schemas/cloud.project.database.service.CapabilityActions" readOnly: true category: allOf: - "$ref": "#/components/schemas/cloud.project.database.engine.CategoryEnum" description: Category of the engine readOnly: true createdAt: type: string description: Date of the creation of the cluster format: date-time readOnly: true description: type: string description: Description of the cluster disk: description: 'Disk attributes of the cluster. DEPRECATED: use storage' "$ref": "#/components/schemas/cloud.project.database.service.Disk" endpoints: type: array description: List of all endpoints of the service items: "$ref": "#/components/schemas/cloud.project.database.service.Endpoint" readOnly: true engine: allOf: - "$ref": "#/components/schemas/cloud.project.database.EngineEnum" description: Name of the engine of the service readOnly: true flavor: type: string description: The VM flavor used for this cluster id: type: string description: Service ID format: uuid readOnly: true ipRestrictions: type: array description: IP Blocks authorized to access to the cluster items: "$ref": "#/components/schemas/cloud.project.database.service.IpRestriction" maintenanceTime: description: Time on which maintenances can start every day "$ref": "#/components/schemas/time" networkId: type: string description: Private network ID in which the cluster is nullable: true format: uuid readOnly: true networkType: allOf: - "$ref": "#/components/schemas/cloud.project.database.NetworkTypeEnum" description: Type of network of the cluster readOnly: true nodeNumber: type: integer description: 'Number of nodes in the cluster. DEPRECATED: use nodes' nodes: type: array description: Nodes of the cluster items: "$ref": "#/components/schemas/cloud.project.database.service.Node" readOnly: true plan: type: string description: Plan of the cluster status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the cluster readOnly: true storage: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.Storage" description: Storage attributes of the cluster nullable: true subnetId: type: string description: Private subnet ID in which the cluster is nullable: true format: uuid readOnly: true version: type: string description: Version of the engine deployed on the cluster cloud.project.database.opensearch.User: type: object description: Opensearch user definition properties: acls: type: array description: Acls of the user items: "$ref": "#/components/schemas/cloud.project.database.opensearch.UserAcl" createdAt: type: string description: Date of the creation of the user format: date-time readOnly: true id: type: string description: User ID format: uuid readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the user readOnly: true username: type: string description: Name of the user readOnly: true cloud.project.database.opensearch.UserAcl: type: object description: Opensearch user acl definition properties: pattern: type: string description: Pattern of the ACL permission: type: string description: Permission of the ACL required: - pattern - permission cloud.project.database.opensearch.UserCreation: type: object description: Opensearch user creation definition properties: acls: type: array description: Acls of the user items: "$ref": "#/components/schemas/cloud.project.database.opensearch.UserAcl" name: type: string description: Name of the user required: - name cloud.project.database.opensearch.UserWithPassword: type: object description: Opensearch user definition properties: acls: type: array description: Acls of the user items: "$ref": "#/components/schemas/cloud.project.database.opensearch.UserAcl" readOnly: true createdAt: type: string description: Date of the creation of the user format: date-time readOnly: true id: type: string description: User ID format: uuid readOnly: true password: type: string description: Password of the user format: password readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the user readOnly: true username: type: string description: Name of the user readOnly: true cloud.project.database.postgresql.ConnectionPool: type: object description: Cloud database postgresql connection pool response body definition properties: databaseId: type: string description: Database used for the connection pool format: uuid id: type: string description: ID of the connection pool format: uuid readOnly: true mode: description: Connection mode to the connection pool "$ref": "#/components/schemas/cloud.project.database.postgresql.connectionpool.ModeEnum" name: type: string description: Name of the connection pool readOnly: true port: type: integer description: Port of the connection pool readOnly: true size: type: integer description: Size of the connection pool sslMode: allOf: - "$ref": "#/components/schemas/cloud.project.database.postgresql.connectionpool.SslModeEnum" description: Ssl connection mode for the pool nullable: true readOnly: true uri: type: string description: Connection URI to the pool readOnly: true userId: type: string description: User authorized to connect to the pool, if none all the users are allowed nullable: true format: uuid cloud.project.database.postgresql.ConnectionPoolCreation: type: object description: Cloud database postgresql connection pool creation body definition properties: databaseId: type: string description: Database used for the connection pool format: uuid mode: description: Connection mode to the connection pool "$ref": "#/components/schemas/cloud.project.database.postgresql.connectionpool.ModeEnum" name: type: string description: Name of the connection pool size: type: integer description: Size of the connection pool userId: type: string description: User authorized to connect to the pool, if none all the users are allowed nullable: true format: uuid required: - databaseId - mode - name - size cloud.project.database.postgresql.QueryStatistics: type: object description: Cloud database postgresql query statistics response body definition properties: queries: type: array description: Statistics of the queries items: "$ref": "#/components/schemas/cloud.project.database.postgresql.querystatistics.Query" readOnly: true cloud.project.database.postgresql.connectionpool.ModeEnum: type: string description: Possible modes for the connection pools enum: - session - statement - transaction cloud.project.database.postgresql.connectionpool.SslModeEnum: type: string description: Possible ssl modes for the connection pools enum: - require cloud.project.database.postgresql.querystatistics.Query: type: object description: Cloud database postgresql single query statistic definition properties: blkReadTime: type: number description: Time spent reading data file blocks by backends in this database, in milliseconds readOnly: true blkWriteTime: type: number description: Time spent writing data file blocks by backends in this database, in milliseconds readOnly: true calls: type: integer description: Number of times this function has been called readOnly: true databaseName: type: string description: Name of the database readOnly: true localBlksDirtied: type: integer description: Total number of local blocks dirtied by the statement readOnly: true localBlksHit: type: integer description: Total number of local block cache hits by the statement readOnly: true localBlksRead: type: integer description: Total number of local blocks read by the statement readOnly: true localBlksWritten: type: integer description: Total number of local blocks written by the statement readOnly: true maxPlanTime: type: number description: Maximum time spent planning the statement, in milliseconds readOnly: true maxTime: type: number description: Maximum time spent for the statement, in milliseconds readOnly: true meanPlanTime: type: number description: Mean time spent planning the statement, in milliseconds readOnly: true meanTime: type: number description: Mean time spent for the statement, in milliseconds readOnly: true minPlanTime: type: number description: Minimum time spent planning the statement, in milliseconds readOnly: true minTime: type: number description: Minimum time spent for the statement, in milliseconds readOnly: true query: type: string description: Text of a representative statement readOnly: true rows: type: integer description: Total number of rows retrieved or affected by the statement readOnly: true sharedBlksDirtied: type: integer description: Total number of shared blocks dirtied by the statement readOnly: true sharedBlksHit: type: integer description: Total number of shared block cache hits by the statement readOnly: true sharedBlksRead: type: integer description: Total number of shared blocks read by the statement readOnly: true sharedBlksWritten: type: integer description: Total number of shared blocks written by the statement readOnly: true stddevPlanTime: type: number description: Population standard deviation of time spent planning the statement, in milliseconds readOnly: true stddevTime: type: number description: Population standard deviation of time spent for the statement, in milliseconds readOnly: true tempBlksRead: type: integer description: Total number of temp blocks read by the statement readOnly: true tempBlksWritten: type: integer description: Total number of temp blocks written by the statement readOnly: true totalPlanTime: type: number description: Total time spent planning the statement, in milliseconds readOnly: true totalTime: type: number description: Total time spent for the statement, in milliseconds readOnly: true username: type: string description: Name of the user who executed the statement readOnly: true walBytes: allOf: - "$ref": "#/components/schemas/complexType.UnitAndValue_long" description: Total amount of WAL generated by the statement in bytes readOnly: true walFpi: type: integer description: Total number of WAL full page images generated by the statement readOnly: true walRecords: type: integer description: Total number of WAL records generated by the statement readOnly: true cloud.project.database.redis.User: type: object description: Redis user definition properties: categories: type: array description: Categories of the user items: type: string channels: type: array description: Channels of the user items: type: string commands: type: array description: Commands of the user items: type: string createdAt: type: string description: Date of the creation of the user format: date-time readOnly: true id: type: string description: User ID format: uuid readOnly: true keys: type: array description: Keys of the user items: type: string status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the user readOnly: true username: type: string description: Name of the user readOnly: true cloud.project.database.redis.UserCreation: type: object description: Redis user definition properties: categories: type: array description: Categories of the user items: type: string channels: type: array description: Channels of the user items: type: string commands: type: array description: Commands of the user items: type: string keys: type: array description: Keys of the user items: type: string name: type: string description: Name of the user required: - name cloud.project.database.redis.UserWithPassword: type: object description: Redis user with password definition properties: categories: type: array description: Categories of the user items: type: string readOnly: true channels: type: array description: Channels of the user items: type: string readOnly: true commands: type: array description: Commands of the user items: type: string readOnly: true createdAt: type: string description: Date of the creation of the user format: date-time readOnly: true id: type: string description: User ID format: uuid readOnly: true keys: type: array description: Keys of the user items: type: string readOnly: true password: type: string description: Password of the user format: password readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the user readOnly: true username: type: string description: Name of the user readOnly: true cloud.project.database.service.Backup: type: object description: Cloud database service backups definition properties: pitr: type: string description: Date until PITR is available nullable: true format: date-time readOnly: true regions: type: array description: Regions on which the backups are stored items: type: string retentionDays: type: integer description: Number of retention days for the backups nullable: true readOnly: true time: description: Time on which backups start every day "$ref": "#/components/schemas/time" cloud.project.database.service.CapabilityActions: type: object description: Cloud database service capability actions definition properties: create: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.capability.StateEnum" description: Defines if the capability can be created nullable: true readOnly: true delete: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.capability.StateEnum" description: Defines if the capability can be deleted nullable: true readOnly: true read: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.capability.StateEnum" description: Defines if the capability can be read nullable: true readOnly: true update: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.capability.StateEnum" description: Defines if the capability can be updated nullable: true readOnly: true cloud.project.database.service.CapabilityEnum: type: string description: List of capabilities available for services enum: - advancedConfiguration - backupRestore - backupTime - backups - certificates - connectionPools - currentQueries - currentQueriesCancel - databases - enableWrites - fork - integrations - ipRestrictions - maintenanceApply - maintenanceTime - maintenances - namespaces - nodes - queryStatistics - queryStatisticsReset - service - userCredentialsReset - users cloud.project.database.service.Certificates: type: object description: Certificates definition for cloud project databases properties: ca: type: string description: CA certificate used for the service readOnly: true cloud.project.database.service.CurrentQueries: type: object description: Cloud database current queries properties: queries: type: array description: Current queries list items: "$ref": "#/components/schemas/cloud.project.database.service.currentqueries.Query" readOnly: true cloud.project.database.service.DataPoint: type: object description: A single value from a metric properties: timestamp: type: integer description: Timestamp in seconds since epoch time readOnly: true value: type: number description: Value of this datapoint readOnly: true cloud.project.database.service.Database: type: object description: Defines the database object in a cluster properties: default: type: boolean description: Defines if the database has been created by default readOnly: true id: type: string description: Database ID format: uuid readOnly: true name: type: string description: Database name required: - name cloud.project.database.service.Disk: type: object description: Defines the disk attributes of a service properties: size: type: integer description: 'Service disk size ' type: type: string description: 'Service disk size ' readOnly: true cloud.project.database.service.Endpoint: type: object description: Defines the endpoint object in a cluster properties: component: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.endpoint.ComponentEnum" description: Type of component the URI relates to readOnly: true domain: type: string description: Domain of the cluster readOnly: true path: type: string description: Path of the endpoint nullable: true readOnly: true port: type: integer description: Connection port for the endpoint nullable: true readOnly: true scheme: type: string description: Scheme used to generate the URI nullable: true readOnly: true ssl: type: boolean description: Defines whether the endpoint uses SSL readOnly: true sslMode: type: string description: SSL mode used to connect to the service if the SSL is enabled nullable: true readOnly: true uri: type: string description: URI of the endpoint nullable: true readOnly: true cloud.project.database.service.HostMetric: type: object description: Metrics datapoints from a specific host properties: dataPoints: type: array description: List of metric's samples items: "$ref": "#/components/schemas/cloud.project.database.service.DataPoint" readOnly: true hostname: type: string description: Name of the originating host readOnly: true cloud.project.database.service.Integration: type: object description: Cloud database service integration definition properties: destinationServiceId: type: string description: ID of the destination service format: uuid id: type: string description: Service ID format: uuid readOnly: true parameters: type: object description: Parameters for the integration nullable: true additionalProperties: type: string sourceServiceId: type: string description: ID of the source service format: uuid status: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.integration.StatusEnum" description: Current status of the integration readOnly: true type: description: Type of the integration "$ref": "#/components/schemas/cloud.project.database.service.integration.TypeEnum" required: - destinationServiceId - sourceServiceId cloud.project.database.service.IpRestriction: type: object description: Ip Restriction definition for cloud project databases properties: description: type: string description: Description of the ip restriction ip: description: Whitelisted IP "$ref": "#/components/schemas/ipBlock" status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the ip restriction readOnly: true cloud.project.database.service.LogEntry: type: object description: A single log entry properties: hostname: type: string description: Host from which the log is coming from readOnly: true message: type: string description: The log message readOnly: true timestamp: type: integer description: Timestamp in seconds since epoch time readOnly: true cloud.project.database.service.Maintenance: type: object description: Cloud database service maintenance definition properties: appliedAt: type: string description: Date of the application of the maintenance nullable: true format: date-time readOnly: true description: type: string description: Description of the maintenance readOnly: true id: type: string description: ID of the maintenance format: uuid readOnly: true scheduledAt: type: string description: Date of the planification of the maintenance nullable: true format: date-time readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.maintenance.StatusEnum" description: Status of the maintenance readOnly: true cloud.project.database.service.Metric: type: object description: Metric definition for cloud project databases properties: metrics: type: array description: Metric values for each cluster's host items: "$ref": "#/components/schemas/cloud.project.database.service.HostMetric" readOnly: true name: type: string description: Name of the metric readOnly: true units: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.MetricUnitEnum" description: Unit of the metric readOnly: true cloud.project.database.service.MetricPeriodEnum: type: string description: Supported metrics query period enum: - lastDay - lastHour - lastMonth - lastWeek - lastYear cloud.project.database.service.MetricUnitEnum: type: string description: Supported unit types for metrics enum: - BYTES - BYTES_PER_SECOND - GIGABYTES - GIGABYTES_PER_HOUR - MEGABYTES - MEGABYTES_PER_SECOND - MILLISECONDS - PERCENT - SCALAR - SCALAR_PER_SECOND - SECONDS - UNKNOWN cloud.project.database.service.Node: type: object description: Cloud databases cluster node definition properties: createdAt: type: string description: Date of the creation of the node format: date-time readOnly: true flavor: type: string description: Flavor of the node readOnly: true id: type: string description: Node ID format: uuid readOnly: true name: type: string description: Name of the node readOnly: true port: type: integer description: Connection port for the node readOnly: true region: type: string description: Region of the node readOnly: true role: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.node.RoleEnum" description: Role of the node nullable: true readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the node readOnly: true cloud.project.database.service.NodeCreation: type: object description: Cloud databases cluster new node definition properties: createdAt: type: string description: Date of the creation of the node format: date-time readOnly: true flavor: type: string description: Flavor of the node id: type: string description: Node ID format: uuid readOnly: true name: type: string description: Name of the node readOnly: true port: type: integer description: Connection port for the node readOnly: true region: type: string description: Region of the node role: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.node.RoleEnum" description: Role of the node nullable: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the node readOnly: true cloud.project.database.service.NodePattern: type: object description: Node pattern definition properties: flavor: type: string description: Flavor of the nodes number: type: integer description: Number of nodes to create region: type: string description: Region of the nodes cloud.project.database.service.Replication: type: object description: Cloud database service replication definition properties: emitHeartbeats: type: boolean description: Defines whether heartbeats are emitted enabled: type: boolean description: Defines whether the replication is actived id: type: string description: Service ID format: uuid readOnly: true replicationPolicyClass: description: ReplicationPolicyClass used for the replication "$ref": "#/components/schemas/cloud.project.database.service.replication.PolicyClassEnum" sourceIntegration: type: string description: ID of the integration source format: uuid readOnly: true syncGroupOffsets: type: boolean description: Defines whether the group offsets must be sync syncInterval: type: integer description: Defines the interval in second between 2 sync targetIntegration: type: string description: ID of the integration target format: uuid readOnly: true topicExcludeList: type: array description: Patterns of the topics to exclude from the replication items: type: string topics: type: array description: Patterns of the topics to replicate items: type: string required: - enabled cloud.project.database.service.ReplicationCreation: type: object description: Cloud database service replication definition properties: emitHeartbeats: type: boolean description: Defines whether heartbeats are emitted enabled: type: boolean description: Defines whether the replication is actived replicationPolicyClass: description: ReplicationPolicyClass used for the replication "$ref": "#/components/schemas/cloud.project.database.service.replication.PolicyClassEnum" sourceIntegration: type: string description: ID of the integration source format: uuid syncGroupOffsets: type: boolean description: Defines whether the group offsets must be sync syncInterval: type: integer description: Defines the interval in second between 2 sync targetIntegration: type: string description: ID of the integration target format: uuid topicExcludeList: type: array description: Patterns of the topics to exclude from the replication items: type: string topics: type: array description: Patterns of the topics to replicate items: type: string required: - enabled - sourceIntegration - targetIntegration cloud.project.database.service.Storage: type: object description: Defines the storage attributes of a service properties: size: description: Service storage size "$ref": "#/components/schemas/complexType.UnitAndValue_long" type: type: string description: Service storage type readOnly: true cloud.project.database.service.User: type: object description: User definition properties: createdAt: type: string description: Date of the creation of the user format: date-time readOnly: true id: type: string description: User ID format: uuid readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the user readOnly: true username: type: string description: Name of the user readOnly: true cloud.project.database.service.UserCreation: type: object description: User creation definition properties: name: type: string description: Name of the user cloud.project.database.service.UserWithPassword: type: object description: User with password definition properties: createdAt: type: string description: Date of the creation of the user format: date-time readOnly: true id: type: string description: User ID format: uuid readOnly: true password: type: string description: Password of the user format: password readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the user readOnly: true username: type: string description: Name of the user readOnly: true cloud.project.database.service.UserWithPasswordAndRoles: type: object description: User with password definition properties: createdAt: type: string description: Date of the creation of the user format: date-time readOnly: true id: type: string description: User ID format: uuid readOnly: true password: type: string description: Password of the user format: password readOnly: true roles: type: array description: Roles the user belongs to items: type: string readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the user readOnly: true username: type: string description: Name of the user readOnly: true cloud.project.database.service.UserWithRoles: type: object description: User definition properties: createdAt: type: string description: Date of the creation of the user format: date-time readOnly: true id: type: string description: User ID format: uuid readOnly: true roles: type: array description: Roles the user belongs to items: type: string status: allOf: - "$ref": "#/components/schemas/cloud.project.database.StatusEnum" description: Current status of the user readOnly: true username: type: string description: Name of the user readOnly: true cloud.project.database.service.UserWithRolesCreation: type: object description: User creation definition properties: name: type: string description: Name of the user roles: type: array description: Roles the user belongs to items: type: string cloud.project.database.service.capability.StateEnum: type: string description: State of the service capability for the service enum: - disabled - enabled cloud.project.database.service.creation.BackupFork: type: object description: 'Defines the source to fork a cluster from a backup. DEPRECATED: use forkFrom' properties: id: type: string description: Backup ID (not compatible with pointInTime) format: uuid pointInTime: type: string description: Point in time to restore from (not compatible with id) format: date-time serviceId: type: string description: Service ID to which the backups belong to format: uuid required: - serviceId cloud.project.database.service.creation.ForkFrom: type: object description: Defines the source to fork a cluster from a backup properties: backupId: type: string description: Backup ID (not compatible with pointInTime) format: uuid pointInTime: type: string description: Point in time to restore from (not compatible with id) format: date-time serviceId: type: string description: Service ID to which the backups belong to format: uuid required: - serviceId cloud.project.database.service.currentqueries.Query: type: object description: Cloud database service current queries query definition properties: applicationName: type: string description: Application name readOnly: true backendStart: type: string description: Backend start timestamp nullable: true format: date-time readOnly: true backendType: type: string description: Backend type nullable: true readOnly: true backendXid: type: integer description: XID for current backend nullable: true readOnly: true backendXmin: type: integer description: Xmin for current backend nullable: true readOnly: true clientHostname: type: string description: Client hostname nullable: true readOnly: true clientIp: allOf: - "$ref": "#/components/schemas/ip" description: Client ip address nullable: true readOnly: true clientPort: type: integer description: Client port nullable: true readOnly: true databaseId: type: integer description: Database ID nullable: true readOnly: true databaseName: type: string description: Database name readOnly: true leaderPid: type: integer description: Leader process ID nullable: true readOnly: true pid: type: integer description: Connection process ID readOnly: true query: type: string description: Current query running on this connection readOnly: true queryDuration: type: number description: Duration of the query in seconds readOnly: true queryStart: type: string description: Query start timestamp nullable: true format: date-time readOnly: true state: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.currentqueries.StateEnum" description: Connection state readOnly: true stateChange: type: string description: Connection state change timestamp nullable: true format: date-time readOnly: true transactionStart: type: string description: Transaction start timestamp nullable: true format: date-time readOnly: true userId: type: integer description: User ID nullable: true readOnly: true userName: type: string description: User name readOnly: true waitEvent: type: string description: Connection wait event nullable: true readOnly: true waitEventType: allOf: - "$ref": "#/components/schemas/cloud.project.database.service.currentqueries.WaitEventTypeEnum" description: Connection wait event type nullable: true readOnly: true cloud.project.database.service.currentqueries.StateEnum: type: string description: Possible state of a query enum: - ACTIVE - DISABLED - FASTPATH_FUNCTION_CALL - IDLE - IDLE_IN_TRANSACTION - IDLE_IN_TRANSACTION_ABORTED cloud.project.database.service.currentqueries.WaitEventTypeEnum: type: string description: Possible event type on which the backend is waiting enum: - ACTIVITY - BUFFER_PIN - CLIENT - EXTENSION - IO - IPC - LOCK - LWLOCK - TIMEOUT cloud.project.database.service.currentqueries.query.CancelRequest: type: object description: Cloud database service current queries query cancel request properties: pid: type: integer description: Database server connection ID terminate: type: boolean description: Request immediate termination instead of soft cancel cloud.project.database.service.currentqueries.query.CancelResponse: type: object description: Cloud database service current queries query cancel response properties: success: type: boolean description: Status reported by the database server readOnly: true cloud.project.database.service.endpoint.ComponentEnum: type: string description: Defines all the values for the component in the service endpoints enum: - cassandra - grafana - graphite - influxdb - kafka - kafkaConnect - kafkaRestApi - kafkaSASL - kafkaSchemaRegistry - kibana - m3coordinator - mongodb - mongodbAnalytics - mongodbSrv - mongodbSrvAnalytics - mysql - mysqlRead - mysqlx - opensearch - postgresql - postgresqlRead - postgresqlReadReplica - prometheusRead - prometheusWrite - redis cloud.project.database.service.integration.StatusEnum: type: string description: Possible state of the integration enum: - READY cloud.project.database.service.integration.TypeEnum: type: string description: Possible type of the service integration enum: - grafanaDashboard - grafanaDatasource - kafkaConnect - kafkaLogs - kafkaMirrorMaker - m3aggregator - m3dbMetrics - opensearchLogs - postgresqlMetrics cloud.project.database.service.maintenance.StatusEnum: type: string description: Possible status of a service maintenance enum: - APPLIED - APPLYING - ERROR - PENDING - SCHEDULED cloud.project.database.service.node.RoleEnum: type: string description: Node role values enum: - ANALYTICS - STANDARD cloud.project.database.service.replication.PolicyClassEnum: type: string description: Possible type of the service integration enum: - org.apache.kafka.connect.mirror.DefaultReplicationPolicy - org.apache.kafka.connect.mirror.IdentityReplicationPolicy cloud.project.floatingIp.AssociatedEntity: type: object description: Associated entity with a floating ip properties: gatewayId: type: string description: ID of the gateway format: uuid readOnly: true id: type: string description: ID of the port format: uuid readOnly: true ip: allOf: - "$ref": "#/components/schemas/ip" description: IP of the port readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.project.floatingIp.associatedEntity.TypeEnum" description: Type of the port readOnly: true cloud.project.floatingIp.StatusEnum: type: string description: Status of a floating ip enum: - active - down - error cloud.project.floatingIp.associatedEntity.TypeEnum: type: string description: Type of the associated entity enum: - dhcp - instance - loadbalancer - routerInterface - unknown cloud.project.loadbalancer.ActionDispatch: type: object description: HTTP load balancer dispatch action properties: name: type: string description: The backend name target: type: string description: Target name required: - name - target cloud.project.loadbalancer.ActionRedirect: type: object description: HTTP load balancer redirect action properties: location: type: string description: Location url name: type: string description: The backend name statusCode: description: StatusCode for redirect action "$ref": "#/components/schemas/cloud.project.loadbalancer.action.RedirectStatusCodeEnum" required: - location - name - statusCode cloud.project.loadbalancer.ActionReject: type: object description: HTTP load balancer reject action properties: name: type: string description: The action name statusCode: description: StatusCode for reject action "$ref": "#/components/schemas/cloud.project.loadbalancer.action.RejectStatusCodeEnum" required: - name - statusCode cloud.project.loadbalancer.ActionRewrite: type: object description: HTTP load balancer rewrite action properties: location: type: string description: Location url name: type: string description: The backend name required: - location - name cloud.project.loadbalancer.Actions: type: object description: HTTP load balancer actions properties: dispatch: type: array description: List of dispatch actions nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.ActionDispatch" redirect: type: array description: List of redirect actions nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.ActionRedirect" reject: type: array description: List of reject actions nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.ActionReject" rewrite: type: array description: List of rewrite actions nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.ActionRewrite" cloud.project.loadbalancer.Address: type: object description: Address to reach the load balancer properties: ipv4: allOf: - "$ref": "#/components/schemas/ipv4" description: IP version 4 readOnly: true ipv6: allOf: - "$ref": "#/components/schemas/ipv6" description: IP version 6 nullable: true readOnly: true cloud.project.loadbalancer.Addresses: type: object description: IP list split in version 4 and 6 properties: ipv4: type: array description: IP version 4 list items: "$ref": "#/components/schemas/ipv4Block" readOnly: true ipv6: type: array description: IP version 6 list nullable: true items: "$ref": "#/components/schemas/ipv6Block" readOnly: true cloud.project.loadbalancer.ApplicationConfiguration: type: object description: An application load balancer configuration properties: actions: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.Actions" description: All actions nullable: true readOnly: true certificates: type: array description: List of certificate ID items: type: string readOnly: true conditions: type: array description: List of conditions nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Condition" readOnly: true entryPoints: type: array description: List of entryPoints items: "$ref": "#/components/schemas/cloud.project.loadbalancer.EntryPoint" readOnly: true networking: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.configuration.networking.Networking" description: networking configuration readOnly: true targets: type: array description: List of targets nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Target" readOnly: true version: type: integer description: Identifier and version of the configuration readOnly: true cloud.project.loadbalancer.ApplicationConfigurationCreation: type: object description: An application load balancer configuration properties: actions: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.Actions" description: All actions nullable: true certificates: type: array description: List of certificate ID items: type: string conditions: type: array description: List of conditions nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Condition" entryPoints: type: array description: List of entryPoints items: "$ref": "#/components/schemas/cloud.project.loadbalancer.EntryPoint" networking: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.configuration.networking.Networking" description: networking configuration nullable: true targets: type: array description: List of targets nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Target" version: type: integer description: Identifier and version of the configuration readOnly: true cloud.project.loadbalancer.Backend: type: object description: A load balancer backend properties: balancer: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.backend.BalancerAlgorithmEnum" description: Use a specific balancer algorithm nullable: true name: type: string description: The backend name proxyProtocol: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.backend.ProxyProtocolEnum" description: Use proxy protocol on backend nullable: true servers: type: array description: List of server in backend items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Server" sticky: type: boolean description: Enable sticky session, only usable with http-mode frontends nullable: true required: - name - servers cloud.project.loadbalancer.BackendSelector: type: object description: Select a load balancer backend properties: name: type: string description: The backend name required: - name cloud.project.loadbalancer.Condition: type: object description: A condition properties: key: type: string description: The condition name nullable: true match: description: Criterion matching operation "$ref": "#/components/schemas/cloud.project.loadbalancer.condition.MatchEnum" name: type: string description: The condition name negate: type: boolean description: Negate the condition nullable: true type: description: Criterion used to chose the appropriate action "$ref": "#/components/schemas/cloud.project.loadbalancer.condition.TypeEnum" values: type: array description: The list of values to match items: type: string required: - match - name - type - values cloud.project.loadbalancer.Configuration: type: object description: A load balancer configuration properties: backends: type: array description: List of backends items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Backend" readOnly: true certificates: type: array description: List of certificate ID items: type: string readOnly: true frontends: type: array description: List of frontends items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Frontend" readOnly: true networking: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.configuration.networking.Networking" description: networking configuration readOnly: true version: type: integer description: Identifier and version of the configuration readOnly: true cloud.project.loadbalancer.ConfigurationCreation: type: object description: A load balancer configuration properties: backends: type: array description: List of backends items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Backend" certificates: type: array description: List of certificate ID items: type: string frontends: type: array description: List of frontends items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Frontend" networking: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.configuration.networking.Networking" description: networking configuration nullable: true version: type: integer description: Identifier and version of the configuration readOnly: true cloud.project.loadbalancer.ConfigurationVersion: type: object description: Information about version of the configuration properties: applied: type: integer description: Applied version of the configuration readOnly: true latest: type: integer description: Latest version of the configuration readOnly: true cloud.project.loadbalancer.EntryPoint: type: object description: A load balancer entryPoint properties: defaultTarget: type: string description: The default target name nullable: true disableH2: type: boolean description: Disable HTTP2 nullable: true name: type: string description: The frontend name portRanges: type: array description: Port ranges to listen nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.PortRange" ports: type: array description: Ports to listen nullable: true items: type: integer rules: type: array description: List of rules items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Rule" tls: type: boolean required: - name cloud.project.loadbalancer.Frontend: type: object description: A load balancer frontend properties: backends: type: array description: Selector for backend items: "$ref": "#/components/schemas/cloud.project.loadbalancer.BackendSelector" mode: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.frontend.ModeEnum" description: Load balancing mode nullable: true name: type: string description: The frontend name port: type: integer description: 'Port to listen (deprecated: see ports)' nullable: true portRanges: type: array description: Port ranges to listen nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.PortRange" ports: type: array description: Ports to listen nullable: true items: type: integer tls: type: boolean whitelist: type: array description: IP range to whitelist items: "$ref": "#/components/schemas/ipBlock" required: - backends - name cloud.project.loadbalancer.LoadBalancerSizeCapability: type: object description: Network load balancer size capability properties: bandwidth: type: integer description: Bandwidth allowed in Mb/s readOnly: true maximumConnection: type: integer description: Maximum connection allowed on the load balancer readOnly: true newConnectionPerSecond: type: integer description: Number of new connection allowed per second readOnly: true size: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.SizeEnum" description: Size of the load balancer readOnly: true cloud.project.loadbalancer.PortRange: type: object description: A port range properties: end: type: integer description: Port range end start: type: integer description: Port range start cloud.project.loadbalancer.Region: type: object description: Region information properties: region: type: string description: Region name readOnly: true cloud.project.loadbalancer.Rule: type: object description: A entrypoint rule properties: action: type: string description: The action name conditions: type: array description: The list of condition to match nullable: true items: type: string required: - action cloud.project.loadbalancer.Server: type: object description: A load balancer backend server properties: ip: description: IP address of a server "$ref": "#/components/schemas/ip" name: type: string description: Server name noCheck: type: boolean description: Disable health check nullable: true port: type: integer description: Port that the server listen weight: type: integer description: Weight of the server in the backend nullable: true required: - ip - name - port cloud.project.loadbalancer.SizeEnum: type: string description: Size of the load balancer enum: - L - M - S cloud.project.loadbalancer.Stats: type: object description: Loadbalancer stats properties: concurrentFlows: type: number description: Concurrent connections readOnly: true httpRequestsPerSecond: type: number description: HTTP requests made nullable: true readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.stats.StatusEnum" description: Main loadbalancer status readOnly: true targets: type: array description: Targets state items: "$ref": "#/components/schemas/cloud.project.loadbalancer.stats.Target" readOnly: true tcpConnectionsPerSecond: type: number description: New connections opened per second readOnly: true throughput: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.stats.Throughput" description: Throughput consumed on the entrypoints readOnly: true cloud.project.loadbalancer.StatusEnum: type: string description: Status of a load balancer enum: - APPLYING - CREATED - DELETING - ERROR - FROZEN - RUNNING cloud.project.loadbalancer.Target: type: object description: A load balancer target properties: balancer: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.target.BalancerAlgorithmEnum" description: Use a specific balancer algorithm nullable: true name: type: string description: The backend name proxyProtocol: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.target.ProxyProtocolEnum" description: Use proxy protocol on target nullable: true servers: type: array description: List of server in target items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Server" sticky: type: boolean description: Enable sticky session, only usable with http-mode frontends nullable: true required: - name - servers cloud.project.loadbalancer.action.RedirectStatusCodeEnum: type: string description: Available status code for Redirect action enum: - '301' - '302' - '303' - '307' - '308' cloud.project.loadbalancer.action.RejectStatusCodeEnum: type: string description: Available status code for Reject action enum: - '200' - '400' - '403' - '405' - '408' - '429' - '500' - '502' - '503' - '504' cloud.project.loadbalancer.backend.BalancerAlgorithmEnum: type: string description: Available load balancer backend balancer algorithm enum: - first - leastconn - roundrobin - source - static-rr cloud.project.loadbalancer.backend.ProxyProtocolEnum: type: string description: Available load balancer backend proxy-protocol enum: - v1 - v2 - v2-cn - v2-ssl cloud.project.loadbalancer.condition.MatchEnum: type: string description: Matching operator enum: - end-with - exists - is - regex - start-with cloud.project.loadbalancer.condition.TypeEnum: type: string description: Matching field enum: - cookie - header - host - method - path - query-param - source cloud.project.loadbalancer.configuration.networking.Egress: type: object description: Networking configuration egress definition properties: id: type: string description: vrack networking id nullable: true format: uuid kind: description: networking egress kind definition "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.egress.KindEnum" required: - kind cloud.project.loadbalancer.configuration.networking.Ingress: type: object description: Networking configuration ingress definition properties: kind: description: networking configuration ingress kind definition "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.ingress.KindEnum" required: - kind cloud.project.loadbalancer.configuration.networking.Networking: type: object description: Networking configuration object properties: egress: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.configuration.networking.Egress" description: Networking configuration definition for egress nullable: true ingress: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.configuration.networking.Ingress" description: Networking configuration definition for ingress nullable: true cloud.project.loadbalancer.frontend.ModeEnum: type: string description: Available load balancer frontend mode enum: - TCP cloud.project.loadbalancer.networking.Egress: type: object description: Networking Egress definition properties: id: type: string description: vrack networking id nullable: true format: uuid kind: description: networking egress kind definition "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.egress.KindEnum" required: - kind cloud.project.loadbalancer.networking.EgressCreation: type: object description: Networking Egress definition properties: kind: description: networking egress kind definition "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.egress.KindEnum" required: - kind cloud.project.loadbalancer.networking.Ingress: type: object description: Networking Ingress definition properties: kind: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.ingress.KindEnum" description: networking ingress kind definition readOnly: true cloud.project.loadbalancer.networking.IngressCreation: type: object description: Networking Ingress definition properties: kind: description: networking ingress kind definition "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.ingress.KindEnum" required: - kind cloud.project.loadbalancer.networking.Networking: type: object description: Networking object properties: egress: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.Egress" description: Networking definition for egress readOnly: true ingress: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.Ingress" description: Networking definition for ingress readOnly: true cloud.project.loadbalancer.networking.NetworkingCreation: type: object description: Networking creation object properties: egress: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.EgressCreation" description: Networking definition for egress nullable: true ingress: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.networking.IngressCreation" description: Networking definition for ingress nullable: true cloud.project.loadbalancer.networking.egress.KindEnum: type: string description: Networking kind enum: - public - vrack cloud.project.loadbalancer.networking.ingress.KindEnum: type: string description: Networking kind enum: - public cloud.project.loadbalancer.stats.StatusEnum: type: string description: Status of availability of loadbalancer enum: - HEALTHY - NOT_AVAILABLE cloud.project.loadbalancer.stats.Target: type: object description: Loadbalancer target stats properties: name: type: string description: Target name readOnly: true servers: type: array description: Concurrent connections items: "$ref": "#/components/schemas/cloud.project.loadbalancer.stats.target.Server" readOnly: true cloud.project.loadbalancer.stats.Throughput: type: object description: Loadbalancer bandwidth stats properties: in: type: number description: Consumed inbound bandwidth (bytes/s) readOnly: true out: type: number description: Consumed outbound bandwidth (bytes/s) readOnly: true cloud.project.loadbalancer.stats.target.Server: type: object description: Loadbalancer target server stats properties: name: type: string description: Target name readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.stats.target.server.StatusEnum" description: Server status readOnly: true cloud.project.loadbalancer.stats.target.server.StatusEnum: type: string description: Status of target's server enum: - ERROR - HEALTHY - INIT - L4_CONNECTION_ERROR - L4_TIMEOUT_ERROR - L7_PROTOCOL_ERROR - L7_RESPONSE_ERROR - L7_TIMEOUT - UNKNOWN cloud.project.loadbalancer.target.BalancerAlgorithmEnum: type: string description: Available load balancer target balancer algorithm enum: - first - leastconn - roundrobin - source - static-rr cloud.project.loadbalancer.target.ProxyProtocolEnum: type: string description: Available load balancer target proxy-protocol enum: - v1 - v2 - v2-cn - v2-ssl cloud.project.networkloadbalancer.ActionReject: type: object description: network load balancer reject action properties: name: type: string description: The action name type: description: type of reject action "$ref": "#/components/schemas/cloud.project.networkloadbalancer.action.RejectTypeEnum" required: - name - type cloud.project.networkloadbalancer.Actions: type: object description: Network Loadbalancer action properties: dispatch: type: array description: List of dispatch actions nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.ActionDispatch" reject: type: array description: List of reject actions nullable: true items: "$ref": "#/components/schemas/cloud.project.networkloadbalancer.ActionReject" cloud.project.networkloadbalancer.Condition: type: object description: A condition properties: key: type: string description: The condition name nullable: true match: description: Criterion matching operation "$ref": "#/components/schemas/cloud.project.loadbalancer.condition.MatchEnum" name: type: string description: The condition name negate: type: boolean description: Negate the condition nullable: true type: description: Criterion used to chose the appropriate action "$ref": "#/components/schemas/cloud.project.networkloadbalancer.condition.TypeEnum" values: type: array description: The list of values to match items: type: string required: - match - name - type - values cloud.project.networkloadbalancer.Configuration: type: object description: A network load balancer configuration properties: actions: allOf: - "$ref": "#/components/schemas/cloud.project.networkloadbalancer.Actions" description: All actions nullable: true readOnly: true conditions: type: array description: List of conditions nullable: true items: "$ref": "#/components/schemas/cloud.project.networkloadbalancer.Condition" readOnly: true entryPoints: type: array description: List of entryPoints items: "$ref": "#/components/schemas/cloud.project.networkloadbalancer.EntryPoint" readOnly: true networking: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.configuration.networking.Networking" description: networking configuration readOnly: true targets: type: array description: List of targets nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Target" readOnly: true version: type: integer description: Identifier and version of the configuration readOnly: true cloud.project.networkloadbalancer.ConfigurationCreation: type: object description: A network load balancer configuration properties: actions: allOf: - "$ref": "#/components/schemas/cloud.project.networkloadbalancer.Actions" description: All actions nullable: true conditions: type: array description: List of conditions nullable: true items: "$ref": "#/components/schemas/cloud.project.networkloadbalancer.Condition" entryPoints: type: array description: List of entryPointss items: "$ref": "#/components/schemas/cloud.project.networkloadbalancer.EntryPoint" networking: allOf: - "$ref": "#/components/schemas/cloud.project.loadbalancer.configuration.networking.Networking" description: networking configuration nullable: true targets: type: array description: List of targets nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Target" version: type: integer description: Identifier and version of the configuration readOnly: true cloud.project.networkloadbalancer.EntryPoint: type: object description: A network load balancer entryPoint properties: defaultTarget: type: string description: The default target name nullable: true name: type: string description: The frontend name portRanges: type: array description: Port ranges to listen nullable: true items: "$ref": "#/components/schemas/cloud.project.loadbalancer.PortRange" ports: type: array description: Ports to listen nullable: true items: type: integer rules: type: array description: List of rules items: "$ref": "#/components/schemas/cloud.project.loadbalancer.Rule" required: - name cloud.project.networkloadbalancer.action.RejectTypeEnum: type: string description: Available type of Reject action enum: - deny - drop cloud.project.networkloadbalancer.condition.TypeEnum: type: string description: Matching field enum: - source cloud.project.region.ImageOsTypeEnum: type: string description: Possible values for image os type enum: - baremetal-linux - linux - windows cloud.project.region.ImageStatusEnum: type: string description: Possible values for image status enum: - active - deleted - error - queued - saving cloud.project.region.ImageVisibilityEnum: type: string description: Possible values for image visibility enum: - community - private - public - shared cloud.quota.AllowedQuota: type: object description: Quotas properties: compute: allOf: - "$ref": "#/components/schemas/cloud.quota.ComputeQuota" description: Quotas for compute readOnly: true name: type: string description: Name readOnly: true network: allOf: - "$ref": "#/components/schemas/cloud.quota.NetworkQuota" description: Quotas for network readOnly: true volume: allOf: - "$ref": "#/components/schemas/cloud.quota.VolumeQuota" description: Quotas for volume readOnly: true cloud.quota.ComputeQuota: type: object description: Quotas for compute properties: cores: type: integer description: Maximum total cores allowed in your project readOnly: true instances: type: integer description: Maximum number of instances allowed in your project readOnly: true ram: type: integer description: Maximum total ram allowed in your project readOnly: true cloud.quota.InstanceUsageQuotas: type: object description: Quotas on instances properties: maxCores: type: integer description: Maximum total cores allowed in your project readOnly: true maxInstances: type: integer description: Maximum total cores allowed in your project readOnly: true maxRam: type: integer readOnly: true usedCores: type: integer description: Current used cores number readOnly: true usedInstances: type: integer description: Current used instances readOnly: true usedRAM: type: integer description: Current used ram readOnly: true cloud.quota.KeymanagerQuotas: type: object description: Quotas on keymanager properties: maxSecrets: type: integer description: Maximum number of secrets allowed in your project readOnly: true usedSecrets: type: integer description: Current number of used secrets readOnly: true cloud.quota.KeypairQuotas: type: object description: Quotas on keypairs properties: maxCount: type: integer description: Maximum keypairs count allowed in your project readOnly: true cloud.quota.LoadbalancerQuotas: type: object description: Quotas on loadbalancer properties: maxLoadbalancers: type: integer description: Maximum number of loadbalancers allowed in your project readOnly: true usedLoadbalancers: type: integer description: Current number of used loadbalancers readOnly: true cloud.quota.NetworkQuota: type: object description: Quotas for network properties: networks: type: integer description: Maximum number of networks allowed in your project readOnly: true ports: type: integer description: Maximum number of ports allowed in your project readOnly: true subnets: type: integer description: Maximum number of subnets allowed in your project readOnly: true cloud.quota.NetworkQuotas: type: object description: Quotas on network properties: maxFloatingIPs: type: integer description: Maximum number of floating ips allowed in your project readOnly: true maxGateways: type: integer description: Maximum number of gateways allowed in your project readOnly: true maxNetworks: type: integer description: Maximum networks allowed in your project readOnly: true maxSubnets: type: integer description: Maximum subnets allowed in your project readOnly: true usedFloatingIPs: type: integer description: Current number of used floating ips readOnly: true usedGateways: type: integer description: Current number of used gateways readOnly: true usedNetworks: type: integer description: Current used networks readOnly: true usedSubnets: type: integer description: Current used subnets readOnly: true cloud.quota.Quotas: type: object description: Quotas properties: instance: allOf: - "$ref": "#/components/schemas/cloud.quota.InstanceUsageQuotas" description: Quotas on instances nullable: true readOnly: true keymanager: allOf: - "$ref": "#/components/schemas/cloud.quota.KeymanagerQuotas" description: Quotas on keymanager nullable: true readOnly: true keypair: allOf: - "$ref": "#/components/schemas/cloud.quota.KeypairQuotas" description: Quotas on keypairs nullable: true readOnly: true loadbalancer: allOf: - "$ref": "#/components/schemas/cloud.quota.LoadbalancerQuotas" description: Quotas on loadbalancer nullable: true readOnly: true network: allOf: - "$ref": "#/components/schemas/cloud.quota.NetworkQuotas" description: Quotas on network nullable: true readOnly: true region: type: string description: Region readOnly: true share: allOf: - "$ref": "#/components/schemas/cloud.quota.share.Quota" description: Quotas on shares nullable: true readOnly: true volume: allOf: - "$ref": "#/components/schemas/cloud.quota.VolumeUsageQuotas" description: Quotas on volumes nullable: true readOnly: true cloud.quota.VolumeQuota: type: object description: Quotas for volume properties: gigabytes: type: integer description: Maximum total volume capacity allowed in your project readOnly: true snapshots: type: integer description: Maximum number of snapshots allowed in your project readOnly: true volumes: type: integer description: Maximum number of volumes allowed in your project readOnly: true cloud.quota.VolumeUsageQuotas: type: object description: Quotas on volumes properties: maxBackupGigabytes: type: integer description: Maximum total volume backup capacity allowed in your project readOnly: true maxGigabytes: type: integer description: Maximum total volume capacity allowed in your project readOnly: true maxVolumeBackupCount: type: integer description: Maximum volumes backup count readOnly: true maxVolumeCount: type: integer description: Maximum volumes count readOnly: true usedBackupGigabytes: type: integer description: Current used volume backup gigabytes readOnly: true usedGigabytes: type: integer description: Current used volume gigabytes readOnly: true volumeBackupCount: type: integer description: Current volumes backup count readOnly: true volumeCount: type: integer description: Current volumes count readOnly: true cloud.quota.share.Quota: type: object description: Share Quota properties: maxShareSizePerShare: type: integer description: Maximum share size of a share readOnly: true maxShareSizeTotal: type: integer description: Maximum share total size for project readOnly: true maxShareSnapshots: type: integer description: Maximum number of share snapshots readOnly: true maxSharesNumber: type: integer description: Maximum number of shares in the quota readOnly: true usedShareSizeTotal: type: integer description: Used share total size for project readOnly: true usedShareSnapshots: type: integer description: Used number of share snapshot readOnly: true usedSharesNumber: type: integer description: Used number of shares in the quota readOnly: true cloud.quota.storage.Quota: type: object description: Cloud Storage Quota properties: bytesUsed: type: integer description: Quota used in bytes readOnly: true containerCount: type: integer description: Number of containers on account readOnly: true objectCount: type: integer description: Number of objects on account readOnly: true quotaBytes: type: integer description: Quota in bytes nullable: true readOnly: true cloud.quota.storage.QuotaUpdate: type: object description: Update storage quota properties: quotaBytes: type: integer description: New quota in bytes required: - quotaBytes cloud.region.Flavor: type: object description: Region flavor properties: disk: type: integer description: Flavor disk size in GB readOnly: true id: type: string description: Flavor ID format: uuid readOnly: true name: type: string description: Flavor name readOnly: true ram: type: integer description: Flavor ram size in MB readOnly: true region: type: string description: Flavor region readOnly: true vcpus: type: integer description: Flavor VCPUs number readOnly: true cloud.region.Image: type: object description: Region image properties: baseImageRef: type: string description: Base image reference readOnly: true createdAt: type: string description: Creation date of the image format: date-time readOnly: true id: type: string description: Image ID format: uuid readOnly: true name: type: string description: Image name readOnly: true osType: allOf: - "$ref": "#/components/schemas/cloud.project.region.ImageOsTypeEnum" description: Image OS type readOnly: true region: type: string description: Image region readOnly: true size: type: integer description: Image size in bytes readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.project.region.ImageStatusEnum" description: Image status readOnly: true visibility: allOf: - "$ref": "#/components/schemas/cloud.project.region.ImageVisibilityEnum" description: Image visibility readOnly: true cloud.region.SSHKey: type: object description: Region SSHKey properties: fingerPrint: type: string description: SSHKey fingerPrint readOnly: true id: type: string description: SSHKey ID readOnly: true name: type: string description: SSHKey name readOnly: true publicKey: type: string description: SSHKey publicKey readOnly: true region: type: string description: SSHKey region readOnly: true cloud.region.Volume: type: object description: Region volume properties: id: type: string description: Volume ID format: uuid readOnly: true name: type: string description: Volume name readOnly: true size: type: integer description: Volume size readOnly: true cloud.role.Permission: type: object description: Role permissions properties: label: type: string description: Permission label readOnly: true roles: type: array description: Roles having this permission items: type: string readOnly: true cloud.role.Role: type: object description: Role properties: description: type: string description: Role Description readOnly: true id: type: string description: Role id readOnly: true name: type: string description: Role Name readOnly: true permissions: type: array description: Permissions granted by this role items: type: string readOnly: true cloud.role.Roles: type: object description: OpenStack role properties: roles: type: array description: OpenStack roles items: "$ref": "#/components/schemas/cloud.role.Role" readOnly: true services: type: array description: OpenStack services items: "$ref": "#/components/schemas/cloud.role.Service" readOnly: true cloud.role.Service: type: object description: OpenStack service properties: name: type: string description: Name of the service readOnly: true permissions: type: array description: List of permissions items: "$ref": "#/components/schemas/cloud.role.Permission" readOnly: true cloud.share.Capability: type: object description: Capability properties: enabled: type: boolean description: Whether the capability is enabled or not readOnly: true name: type: string description: Capability name readOnly: true cloud.share.ExportLocationObject: type: object description: Object properties: id: type: string description: Export location id readOnly: true path: type: string description: Export location mount path readOnly: true cloud.share.ProtocolEnum: type: string description: Share protocol enum: - NFS cloud.share.Share: type: object description: Share properties: capabilities: type: array description: Share capabilities nullable: true items: "$ref": "#/components/schemas/cloud.share.Capability" readOnly: true createdAt: type: string description: The date and timestamp when the resource was created format: date-time readOnly: true description: type: string description: Share description nullable: true exportLocations: type: array description: Share export locations nullable: true items: "$ref": "#/components/schemas/cloud.share.ExportLocationObject" readOnly: true id: type: string description: Share ID format: uuid readOnly: true isPublic: type: boolean description: Whether the share is public readOnly: true name: type: string description: Share name nullable: true protocol: allOf: - "$ref": "#/components/schemas/cloud.share.ProtocolEnum" description: Share protocol readOnly: true region: type: string description: Region readOnly: true size: type: integer description: Share size in GB status: allOf: - "$ref": "#/components/schemas/cloud.share.StatusEnum" description: Share status readOnly: true updatedAt: type: string description: The date and timestamp when the resource was updated for the last time format: date-time readOnly: true cloud.share.ShareUpdate: type: object description: Input Object used to create a share properties: description: type: string description: Share description name: type: string description: Share name newSize: type: integer description: New share size in GB cloud.share.StatusEnum: type: string description: Share status enum: - available - awaiting_transfer - backup_creating - backup_restoring - backup_restoring_error - creating - creating_from_snapshot - deleted - deleting - error - error_deleting - extending - extending_error - inactive - manage_error - manage_starting - migrating - migrating_to - replication_change - reverting - reverting_error - shrinking - shrinking_error - shrinking_possible_data_loss_error - unmanage_error - unmanage_starting - unmanaged cloud.share.acl.ACL: type: object description: Share ACL properties: accessLevel: allOf: - "$ref": "#/components/schemas/cloud.share.acl.AccessLevelEnum" description: ACL Access Level readOnly: true accessTo: type: string description: ACL Access Resource readOnly: true accessType: allOf: - "$ref": "#/components/schemas/cloud.share.acl.AccessTypeEnum" description: ACL Access Type readOnly: true createdAt: type: string description: The date and timestamp when the resource was created format: date-time readOnly: true id: type: string description: ACL ID format: uuid readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.share.acl.StatusEnum" description: ACL Status readOnly: true updatedAt: type: string description: The date and timestamp when the resource was updated for the last time format: date-time readOnly: true cloud.share.acl.ACLCreate: type: object description: Share ACL properties: accessLevel: description: ACL Access Level "$ref": "#/components/schemas/cloud.share.acl.AccessLevelEnum" accessTo: type: string description: ACL Access Resource accessType: description: ACL Access Type "$ref": "#/components/schemas/cloud.share.acl.AccessTypeEnum" cloud.share.acl.AccessLevelEnum: type: string description: ACL Access Level enum: - ro - rw cloud.share.acl.AccessTypeEnum: type: string description: ACL Access Type enum: - cert - ip - user cloud.share.acl.StatusEnum: type: string description: ACL Status enum: - active - applying - denying - error - queued_to_apply - queued_to_deny cloud.share.snapshot.Snapshot: type: object description: Share snapshot properties: createdAt: type: string description: The date and timestamp when the resource was created format: date-time readOnly: true description: type: string description: Snapshot description nullable: true id: type: string description: Snapshot ID format: uuid readOnly: true name: type: string description: Snapshot name nullable: true shareId: type: string description: Share ID format: uuid readOnly: true shareProtocol: allOf: - "$ref": "#/components/schemas/cloud.share.ProtocolEnum" description: Share protocol nullable: true readOnly: true shareSize: type: integer description: Share size in GB readOnly: true size: type: integer description: Snapshot size in GB readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.share.snapshot.StatusEnum" description: Snapshot status readOnly: true cloud.share.snapshot.StatusEnum: type: string description: Snapshot Status enum: - available - creating - deleting - error - error_deleting - manage_error - manage_starting - restoring - unmanage_error - unmanage_starting cloud.sshkey.SshKey: type: object description: SshKey properties: id: type: string description: SSH key id readOnly: true name: type: string description: SSH key name readOnly: true publicKey: type: string description: SSH public key readOnly: true regions: type: array description: SSH key regions items: type: string readOnly: true cloud.sshkey.SshKeyDetail: type: object description: SshKeyDetail properties: fingerPrint: type: string description: SSH key fingerprint readOnly: true id: type: string description: SSH key id readOnly: true name: type: string description: SSH key name readOnly: true publicKey: type: string description: SSH public key readOnly: true regions: type: array description: SSH key regions items: type: string readOnly: true cloud.stack.Content: type: object description: Content properties: content: type: string description: Content readOnly: true type: type: string description: Type of the content readOnly: true cloud.stack.InstructionGuide: type: object description: InstructionGuide properties: content: type: array description: Guide introduction content items: "$ref": "#/components/schemas/cloud.stack.Content" readOnly: true language: type: string description: Guide language readOnly: true sections: type: array description: Sections of the guide items: "$ref": "#/components/schemas/cloud.stack.Section" readOnly: true title: type: string description: Guide title readOnly: true cloud.stack.Section: type: object description: Section properties: content: type: array description: Content of the guide section items: "$ref": "#/components/schemas/cloud.stack.Content" readOnly: true steps: type: array description: Steps to follow items: "$ref": "#/components/schemas/cloud.stack.Step" readOnly: true title: type: string description: Title of the guide section readOnly: true cloud.stack.Stack: type: object description: Stack properties: commit: type: string description: Stack last commit readOnly: true description: type: string description: Stack description readOnly: true gitRepository: type: string description: GIT repository readOnly: true instructions: type: array description: Instructions to start the stack items: "$ref": "#/components/schemas/cloud.stack.InstructionGuide" readOnly: true name: type: string description: Stack name readOnly: true release: type: string description: Stack release tag readOnly: true uuid: type: string description: Stack uuid readOnly: true cloud.stack.Step: type: object description: Step properties: content: type: array description: Content of the step items: "$ref": "#/components/schemas/cloud.stack.Content" readOnly: true title: type: string description: Title of the step readOnly: true cloud.storage.AddContainerPolicy: type: object description: Add storage policy for container properties: objectKey: type: string description: Container object key roleName: description: Policy role "$ref": "#/components/schemas/cloud.storage.PolicyRoleEnum" required: - roleName cloud.storage.Container: type: object description: Container properties: archive: type: boolean description: Whether this is an archive container or not nullable: true readOnly: true containerType: allOf: - "$ref": "#/components/schemas/cloud.storage.TypeEnum" description: Container type nullable: true readOnly: true id: type: string description: Storage id readOnly: true name: type: string description: Storage name readOnly: true region: type: string readOnly: true storedBytes: type: integer description: Total bytes stored readOnly: true storedObjects: type: integer description: Total objects stored readOnly: true cloud.storage.ContainerAccess: type: object description: ContainerAccess properties: endpoints: type: array description: Storage access endpoints items: "$ref": "#/components/schemas/cloud.storage.Endpoint" readOnly: true token: type: string description: Storage access token readOnly: true cloud.storage.ContainerDetail: type: object description: ContainerDetail properties: archive: type: boolean description: Whether this is an archive container or not readOnly: true containerType: allOf: - "$ref": "#/components/schemas/cloud.storage.TypeEnum" description: Container type readOnly: true cors: type: array description: Origins allowed to make Cross Origin Requests items: type: string readOnly: true name: type: string description: Container name readOnly: true objects: type: array description: Objects stored in container items: "$ref": "#/components/schemas/cloud.storage.ContainerObject" readOnly: true public: type: boolean description: 'Public container (DEPRECATED: see containerType)' readOnly: true region: type: string description: Container region readOnly: true staticUrl: type: string description: Container static URL readOnly: true storedBytes: type: integer description: Total bytes stored readOnly: true storedObjects: type: integer description: Total objects stored readOnly: true cloud.storage.ContainerObject: type: object description: ContainerObject properties: contentType: type: string description: Object content type readOnly: true lastModified: type: string description: Last modification date format: date-time readOnly: true name: type: string description: Object name readOnly: true retrievalDelay: type: integer description: Object retrieval delay (when unsealing) readOnly: true retrievalState: allOf: - "$ref": "#/components/schemas/cloud.storage.RetrievalStateEnum" description: Object retrieval state readOnly: true size: type: integer description: Object size readOnly: true cloud.storage.ContainerObjectTempURL: type: object description: ContainerObjectTempURL properties: expirationDate: type: string description: Temporary URL expiration date format: date-time readOnly: true getURL: type: string description: Temporary URL to get object readOnly: true cloud.storage.EncryptionAlgorithmEnum: type: string description: Encryption algorithm enum: - AES256 - plaintext cloud.storage.Endpoint: type: object description: Endpoint properties: region: type: string description: Endpoint region readOnly: true url: type: string description: Endpoint URL readOnly: true cloud.storage.PolicyRaw: type: object description: Raw storage policy properties: policy: type: string description: Raw storage policy cloud.storage.PolicyRoleEnum: type: string description: Storage policy role enum: - admin - deny - readOnly - readWrite cloud.storage.PresignedURL: type: object description: Presigned URL properties: method: allOf: - "$ref": "#/components/schemas/cloud.storage.PresignedURLMethodEnum" description: Presigned URL method readOnly: true signedHeaders: type: object description: Signed headers additionalProperties: type: string readOnly: true url: type: string description: Presigned URL readOnly: true cloud.storage.PresignedURLInput: type: object description: Inputs to generate a presigned URL properties: expire: type: integer description: URL expiration in seconds method: description: Presigned URL method "$ref": "#/components/schemas/cloud.storage.PresignedURLMethodEnum" object: type: string description: Object name storageClass: description: Storage class "$ref": "#/components/schemas/cloud.storage.StorageClassEnum" cloud.storage.PresignedURLMethodEnum: type: string description: Presigned URL method enum: - DELETE - GET - PUT cloud.storage.Quota: type: object description: Cloud Storage Quota properties: buckets: type: integer description: Current number of buckets readOnly: true maxBuckets: type: integer description: Maximum number of buckets readOnly: true cloud.storage.RetrievalStateEnum: type: string description: RetrievalStateEnum enum: - sealed - unsealed - unsealing cloud.storage.RightEnum: type: string description: RightEnum enum: - all - read - write cloud.storage.StorageClassEnum: type: string description: Storage class enum: - HIGH_PERF - STANDARD cloud.storage.TypeEnum: type: string description: TypeEnum enum: - private - public - static cloud.storage.VersioningStatusEnum: type: string description: Versioning status enum: - enabled - suspended cloud.user.Configuration: type: object description: Client Cloud Configuration properties: content: type: string description: Client configuration readOnly: true cloud.user.Openrc: type: object description: Openrc properties: content: type: string description: openrc file readOnly: true cloud.user.OpenrcVersionEnum: type: string description: OpenrcVersionEnum enum: - v2.0 - v3 cloud.user.RCloneServiceEnum: type: string description: RCloneServiceEnum enum: - storage - storage-s3 cloud.user.Rclone: type: object description: Rclone properties: content: type: string description: rclone configuration file readOnly: true cloud.user.RoleEnum: type: string description: RoleEnum enum: - admin - administrator - ai_training_operator - ai_training_read - authentication - backup_operator - compute_operator - image_operator - infrastructure_supervisor - network_operator - network_security_operator - objectstore_operator - volume_operator cloud.user.S3Credentials: type: object description: S3Credentials properties: access: type: string description: S3 Access key readOnly: true tenantId: type: string description: Tenant id readOnly: true userId: type: string description: User id readOnly: true cloud.user.S3CredentialsSecretOnly: type: object description: S3CredentialsSecretOnly properties: secret: type: string description: S3 Access key secret format: password readOnly: true cloud.user.S3CredentialsWithSecret: type: object description: S3CredentialsWithSecret properties: access: type: string description: S3 Access key readOnly: true secret: type: string description: S3 Access key secret format: password readOnly: true tenantId: type: string description: Tenant id readOnly: true userId: type: string description: User id readOnly: true cloud.user.User: type: object description: User properties: creationDate: type: string description: User creation date format: date-time readOnly: true description: type: string description: User description readOnly: true id: type: integer description: User id readOnly: true openstackId: type: string description: User id on openstack nullable: true readOnly: true roles: type: array description: User roles items: "$ref": "#/components/schemas/cloud.role.Role" readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.user.UserStatusEnum" description: User status readOnly: true username: type: string description: Username readOnly: true cloud.user.UserDetail: type: object description: UserDetail properties: creationDate: type: string description: User creation date format: date-time readOnly: true description: type: string description: User description readOnly: true id: type: integer description: User id readOnly: true openstackId: type: string description: User id on openstack nullable: true readOnly: true password: type: string description: User password readOnly: true roles: type: array description: User roles items: "$ref": "#/components/schemas/cloud.role.Role" readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.user.UserStatusEnum" description: User status readOnly: true username: type: string description: Username readOnly: true cloud.user.UserStatusEnum: type: string description: UserStatusEnum enum: - creating - deleted - deleting - ok cloud.volume.Snapshot: type: object description: Snapshot properties: creationDate: type: string description: Snapshot creation date format: date-time readOnly: true description: type: string description: Snapshot description readOnly: true id: type: string description: Snapshot id readOnly: true name: type: string description: Snapshot name readOnly: true planCode: type: string description: Order plan code nullable: true readOnly: true region: type: string description: Snapshot region readOnly: true size: type: integer description: Snapshot size readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.volume.SnapshotStatusEnum" description: Snapshot status readOnly: true volumeId: type: string description: Volume source id readOnly: true cloud.volume.SnapshotStatusEnum: type: string description: SnapshotStatusEnum enum: - available - creating - deleting - error - error_deleting cloud.volume.Volume: type: object description: Volume properties: attachedTo: type: array description: Volume attached to instances id items: type: string readOnly: true bootable: type: boolean description: Volume bootable readOnly: true creationDate: type: string description: Volume creation date format: date-time readOnly: true description: type: string description: Volume description readOnly: true id: type: string description: Volume id readOnly: true name: type: string description: Volume name readOnly: true planCode: type: string description: Order plan code nullable: true readOnly: true region: type: string description: Volume region readOnly: true size: type: integer description: Volume size (in GB) readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.volume.VolumeStatusEnum" description: Volume status readOnly: true type: allOf: - "$ref": "#/components/schemas/cloud.volume.VolumeTypeEnum" description: Volume type readOnly: true cloud.volume.VolumeStatusEnum: type: string description: VolumeStatusEnum enum: - attaching - available - awaiting-transfer - backing-up - creating - deleting - detaching - downloading - error - error_backing-up - error_deleting - error_extending - error_restoring - extending - in-use - maintenance - reserved - restoring-backup - retyping - uploading cloud.volume.VolumeTypeEnum: type: string description: VolumeTypeEnum enum: - classic - high-speed - high-speed-gen2 cloud.volumeBackup.VolumeBackup: type: object description: A volume backup properties: creationDate: type: string description: Creation date of the backup format: date-time readOnly: true id: type: string description: Volume backup id format: uuid readOnly: true name: type: string description: Volume backup name readOnly: true region: type: string description: Volume backup region readOnly: true size: type: integer description: Size of the backup in GiB readOnly: true status: allOf: - "$ref": "#/components/schemas/cloud.volumeBackup.VolumeBackupStatusEnum" description: Staus of the backup readOnly: true volumeId: type: string description: ID of the volume used to create the backup format: uuid readOnly: true cloud.volumeBackup.VolumeBackupCreation: type: object description: Create a volume backup properties: name: type: string description: name of the backup volumeId: type: string description: ID of the volume to backup format: uuid required: - volumeId cloud.volumeBackup.VolumeBackupRestore: type: object description: Restore a volume backup on a volume properties: volumeId: type: string description: ID of the volume to restore on format: uuid required: - volumeId cloud.volumeBackup.VolumeBackupStatusEnum: type: string description: VolumeBackupStatusEnum enum: - creating - deleting - error - ok - restoring cloud.volumeBackup.VolumeCreationFromBackup: type: object description: Create a volume from a volume backup properties: name: type: string description: name of the new volume complexType.UnitAndValue_long: type: object properties: unit: type: string readOnly: true value: type: integer dbaas.logs.LogKind: type: object description: Log kind properties: additionalReturnedFields: type: array description: List of additional log fields managed in this log kind items: type: string readOnly: true createdAt: type: string description: Creation date of the log kind format: date-time readOnly: true displayName: type: string description: Log kind display name readOnly: true kindId: type: string description: Log kind ID format: uuid readOnly: true name: type: string description: Log kind name readOnly: true updatedAt: type: string description: Last update date of the log kind format: date-time readOnly: true dbaas.logs.LogUrlCreation: type: object description: Log temporary URL creation payload properties: kind: type: string description: Log kind name required: - kind dbaas.logs.TemporaryLogsLink: type: object description: Temporary url information properties: expirationDate: type: string description: Temporary url expiration date format: date-time readOnly: true url: type: string description: Temporary url readOnly: true duration: type: string description: Duration (e.g., P1Y2M3DT4H6M9S) example: P1Y2M3DT4H6M9S email: type: string description: Email address (e.g., api@ml.ovh.net) format: email example: api@ml.ovh.net iam.ResourceMetadata: type: object description: IAM resource metadata embedded in services models properties: displayName: type: string description: Resource display name nullable: true readOnly: true id: type: string description: Unique identifier of the resource format: uuid readOnly: true tags: type: object description: 'Resource tags. Tags that were internally computed are prefixed with ovh:' nullable: true additionalProperties: type: string readOnly: true urn: type: string description: Unique resource name used in policies readOnly: true iam.resource.TagFilter: type: object description: Resource tag filter properties: operator: allOf: - "$ref": "#/components/schemas/iam.resource.TagFilter.OperatorEnum" description: Operator to use in order to filter on the value (defaults to 'EQ') nullable: true readOnly: true value: type: string description: Value to use in order to filter tags readOnly: true iam.resource.TagFilter.OperatorEnum: type: string description: Operator that can be used in order to filter resources tags enum: - EQ internationalPhoneNumber: type: string description: International phone number format: phone-number ip: type: string description: IP address (e.g., 192.0.2.0) format: ipv4 example: 192.0.2.0 ipBlock: type: string description: IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24) format: ip-block example: 192.0.2.0/24 ipInterface: type: string description: IP address (e.g., 192.0.2.0) format: ipv4 example: 192.0.2.0 ipv4: type: string description: IPv4 address (e.g., 192.0.2.0) format: ipv4 example: 192.0.2.0 ipv4Block: type: string description: IPv4 CIDR notation (e.g., 192.0.2.0/24) format: ipv4-block example: 192.0.2.0/24 ipv6: type: string description: IPv6 address (e.g., 2001:41d0:1:1994::1) format: ipv6 example: 2001:41d0:1:1994::1 ipv6Block: type: string description: IPv6 CIDR notation (e.g., 2001:41d0::/128) format: ipv6-block example: 2001:41d0::/128 macAddress: type: string description: MAC address (e.g., 2001:4860:4860::8844) format: mac-address example: 2001:4860:4860::8888. 2001:4860:4860::8844 nichandle.OvhSubsidiaryEnum: type: string description: OVH subsidiaries enum: - ASIA - AU - CA - CZ - DE - ES - EU - FI - FR - GB - IE - IT - LT - MA - NL - PL - PT - QC - SG - SN - TN - US - WE - WS phoneNumber: type: string description: Phone number format: phone-number service.RenewType: type: object description: Map a possible renew for a specific service properties: automatic: type: boolean description: The service is automatically renewed deleteAtExpiration: type: boolean description: The service will be deleted at expiration forced: type: boolean description: The service forced to be renewed manualPayment: type: boolean description: The service needs to be manually renewed and paid nullable: true period: type: integer description: period of renew in month nullable: true service.RenewalTypeEnum: type: string description: Detailed renewal type of a service enum: - automaticForcedProduct - automaticV2012 - automaticV2014 - automaticV2016 - manual - oneShot - option service.StateEnum: type: string enum: - expired - inCreation - ok - pendingDebt - unPaid service.TerminationFutureUseEnum: type: string description: All future uses you can provide for a service termination enum: - NOT_REPLACING_SERVICE - OTHER - SUBSCRIBE_AN_OTHER_SERVICE - SUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITOR - SUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITOR service.TerminationReasonEnum: type: string description: All reasons you can provide for a service termination enum: - FEATURES_DONT_SUIT_ME - LACK_OF_PERFORMANCES - MIGRATED_TO_ANOTHER_OVH_PRODUCT - MIGRATED_TO_COMPETITOR - NOT_ENOUGH_RECOGNITION - NOT_NEEDED_ANYMORE - NOT_RELIABLE - NO_ANSWER - OTHER - PRODUCT_DIMENSION_DONT_SUIT_ME - PRODUCT_TOOLS_DONT_SUIT_ME - TOO_EXPENSIVE - TOO_HARD_TO_USE - UNSATIFIED_BY_CUSTOMER_SUPPORT services.Service: type: object description: Details about a Service properties: canDeleteAtExpiration: type: boolean description: Indicates that the service can be set up to be deleted at expiration readOnly: true contactAdmin: type: string readOnly: true contactBilling: type: string readOnly: true contactTech: type: string readOnly: true creation: type: string format: date readOnly: true domain: type: string readOnly: true engagedUpTo: type: string nullable: true format: date readOnly: true expiration: type: string format: date readOnly: true possibleRenewPeriod: type: array description: All the possible renew period of your service in month nullable: true items: type: integer readOnly: true renew: allOf: - "$ref": "#/components/schemas/service.RenewType" description: Way of handling the renew nullable: true renewalType: allOf: - "$ref": "#/components/schemas/service.RenewalTypeEnum" readOnly: true serviceId: type: integer readOnly: true status: allOf: - "$ref": "#/components/schemas/service.StateEnum" readOnly: true time: type: string description: Time (e.g., 15:04:05) format: time example: '15:04:05' securitySchemes: oAuth2AuthCode: type: oauth2 description: Oauth2 x-client-id: 6976d569147cfaff x-client-secret: 3586fea59c3ef4d3a829b398a865fb95 flows: authorizationCode: authorizationUrl: https://us.ovhcloud.com/auth/oauth2/authorize tokenUrl: https://us.ovhcloud.com/auth/oauth2/token scopes: account/all: Manage your account all: Manage your whole account and all your services services/all: Manage your services lifecycle and billing paths: "/cloud/order": get: summary: OVH Cloud Get all cloud pending orders security: - oAuth2AuthCode: [] parameters: - in: query name: planCode description: Order plan code schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.order.Order" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/order\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/order"); print_r($result); ?> x-iam-actions: - name: account:apiovh:cloud/order/get required: true tags: - Cloud "/cloud/order/rule/availability": get: summary: OVH Cloud Get product availability security: - oAuth2AuthCode: [] parameters: - in: query name: addonFamily description: Addon family filter schema: type: string - in: query name: ovhSubsidiary description: OVH subsidiary required: true schema: "$ref": "#/components/schemas/nichandle.OvhSubsidiaryEnum" - in: query name: planCode description: Plan code filter schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.order.rule.Availability" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/order/rule/availability\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/order/rule/availability"); print_r($result); ?> x-iam-actions: - name: account:apiovh:cloud/order/rule/availability/get required: true tags: - Cloud "/cloud/order/rule/instanceCategory": get: summary: OVH Cloud Get instance categories security: - oAuth2AuthCode: [] responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.order.rule.InstanceCategories" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/order/rule/instanceCategory\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/order/rule/instanceCategory"); print_r($result); ?> x-iam-actions: - name: account:apiovh:cloud/order/rule/instanceCategory/get required: true tags: - Cloud "/cloud/project": get: summary: OVH Cloud List available services security: - oAuth2AuthCode: [] parameters: - in: query name: iamTags description: Filter resources on IAM tags schema: type: object additionalProperties: type: array items: "$ref": "#/components/schemas/iam.resource.TagFilter" responses: '200': description: successful operation content: application/json: schema: type: array items: type: string x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:get required: true x-expanded-response: CloudProjectWithIAM tags: - Cloud "/cloud/project/{serviceName}": get: summary: OVH Cloud Get this object properties security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectWithIAM" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:get required: true tags: - Cloud put: summary: OVH Cloud Alter this object properties security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.Project" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.Project\nresult = client.put(\"/cloud/project/{serviceName}\",\n\tmanualQuota = None, # Manual quota prevent automatic quota upgrade (type: boolean)\n\tdescription = None, # Description of your project (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}\", array(\n\tdescription => null, // Description of your project (type: string, nullable)\n\tmanualQuota => null, // Manual quota prevent automatic quota upgrade (type: boolean)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:edit required: true tags: - Cloud "/cloud/project/{serviceName}/activateMonthlyBilling": post: summary: OVH Cloud Activate monthly billing on multiple instances security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectActivateMonthlyBillingCreation" responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.instance.InstanceDetail" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectActivateMonthlyBillingCreation\nresult = client.post(\"/cloud/project/{serviceName}/activateMonthlyBilling\",\n\tinstances = None, # Instance ids and regions (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/activateMonthlyBilling\", array(\n\tinstances => null, // Instance ids and regions (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:activateMonthlyBilling required: true tags: - Cloud "/cloud/project/{serviceName}/capabilities/containerRegistry": get: summary: OVH Cloud List container registry capabilities per region security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.containerRegistry.Capability" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/capabilities/containerRegistry\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/capabilities/containerRegistry"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:capabilities/containerRegistry/get required: true tags: - Cloud "/cloud/project/{serviceName}/capabilities/kube/admissionplugins": get: summary: OVH Cloud List of admissionPlugins managed by MKS product that can be enabled or disabled. security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.ProjectKubeCustomizationAPIServerAdmissionPluginsEnum" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/capabilities/kube/admissionplugins\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/capabilities/kube/admissionplugins"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:capabilities/kube/admissionplugins/get required: true tags: - Cloud "/cloud/project/{serviceName}/capabilities/kube/flavors": get: summary: OVH Cloud List Kubernetes available flavors for a region security: - oAuth2AuthCode: [] parameters: - in: query name: region description: 'The region to list available flavors from. Example: GRA11.' schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.kube.Flavor" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/capabilities/kube/flavors\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/capabilities/kube/flavors"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:capabilities/kube/flavors/get required: true tags: - Cloud "/cloud/project/{serviceName}/capabilities/kube/log/kind": get: summary: OVH Cloud List available log kinds security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/capabilities/kube/log/kind\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/capabilities/kube/log/kind"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:capabilities/kube/log/kind/get required: true x-expanded-response: DbaasLogsLogKind tags: - Cloud "/cloud/project/{serviceName}/capabilities/kube/log/kind/{name}": get: summary: OVH Cloud Get a log kind security: - oAuth2AuthCode: [] parameters: - in: path name: name description: Name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/dbaas.logs.LogKind" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/capabilities/kube/log/kind/{name}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/capabilities/kube/log/kind/{name}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:capabilities/kube/log/kind/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/capabilities/kube/regions": get: summary: OVH Cloud List Kubernetes regions where cluster creation is possible. security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/capabilities/kube/regions\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/capabilities/kube/regions"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:capabilities/kube/regions/get required: true tags: - Cloud "/cloud/project/{serviceName}/capabilities/loadbalancer/region": get: summary: OVH Cloud List all available regions security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/capabilities/loadbalancer/region\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/capabilities/loadbalancer/region"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:capabilities/loadbalancer/region/get required: true x-expanded-response: CloudProjectLoadbalancerRegion tags: - Cloud "/cloud/project/{serviceName}/capabilities/loadbalancer/region/{regionName}": get: summary: OVH Cloud Get specific information of a region security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.loadbalancer.Region" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/capabilities/loadbalancer/region/{regionName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/capabilities/loadbalancer/region/{regionName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:capabilities/loadbalancer/region/get required: true x-response-identifier: region tags: - Cloud "/cloud/project/{serviceName}/capabilities/productAvailability": get: summary: OVH Cloud List product availability security: - oAuth2AuthCode: [] parameters: - in: query name: addonFamily description: Addon family filter schema: type: string - in: query name: ovhSubsidiary description: OVH subsidiary required: true schema: "$ref": "#/components/schemas/nichandle.OvhSubsidiaryEnum" - in: query name: planCode description: Plan code filter schema: type: string - in: query name: planFamily description: Plan family filter (deprecated, use addonFamily instead) schema: type: string - in: query name: product description: Product filter schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.capabilities.Availability" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/capabilities/productAvailability\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/capabilities/productAvailability"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:capabilities/productAvailability/get required: true tags: - Cloud "/cloud/project/{serviceName}/confirmTermination": post: summary: OVH Cloud Confirm service termination security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: The project id required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: commentary: type: string description: Commentary about your termination request futureUse: description: What next after your termination request "$ref": "#/components/schemas/service.TerminationFutureUseEnum" reason: description: Reason of your termination request "$ref": "#/components/schemas/service.TerminationReasonEnum" token: type: string description: The termination token sent by email to the admin contact required: - token responses: '200': description: successful operation content: application/json: schema: type: string x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/confirmTermination\",\n\tcommentary = None, # Commentary about your termination request (type: string, nullable)\n\tfutureUse = None, # What next after your termination request (type: service.TerminationFutureUseEnum, nullable)\n\treason = None, # Reason of your termination request (type: service.TerminationReasonEnum, nullable)\n\ttoken = None, # The termination token sent by email to the admin contact (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/confirmTermination\", array(\n\tcommentary => null, // Commentary about your termination request (type: string, nullable)\n\tfutureUse => null, // What next after your termination request (type: service.TerminationFutureUseEnum, nullable)\n\treason => null, // Reason of your termination request (type: service.TerminationReasonEnum, nullable)\n\ttoken => null, // The termination token sent by email to the admin contact (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:confirmTermination required: true tags: - Cloud "/cloud/project/{serviceName}/containerRegistry": get: summary: OVH Cloud List registries of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.containerRegistry.Registry" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/containerRegistry\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/containerRegistry"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/get required: true x-response-identifier: id x-expanded-response: CloudContainerRegistryRegistry tags: - Cloud post: summary: OVH Cloud Create a new registry security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectContainerRegistryCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.containerRegistry.Registry" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectContainerRegistryCreation\nresult = client.post(\"/cloud/project/{serviceName}/containerRegistry\",\n\tplanID = None, # ID of the plan to use for the new registry (type: string)\n\tregion = None, # Region where to deploy the registry. Get available regions with /cloud/project/{serviceName}/capabilities/containerRegistry. (type: string)\n\tname = None, # Name of the new registry (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/containerRegistry\", array(\n\tregion => null, // Region where to deploy the registry. Get available regions with /cloud/project/{serviceName}/capabilities/containerRegistry. (type: string)\n\tname => null, // Name of the new registry (type: string)\n\tplanID => null, // ID of the plan to use for the new registry (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/create required: true tags: - Cloud "/cloud/project/{serviceName}/containerRegistry/{registryID}": delete: summary: OVH Cloud Delete a registry security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/containerRegistry/{registryID}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/containerRegistry/{registryID}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/delete required: true tags: - Cloud get: summary: OVH Cloud Get the registry information security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.containerRegistry.Registry" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/containerRegistry/{registryID}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/containerRegistry/{registryID}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update the registry security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectContainerRegistryUpdate" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectContainerRegistryUpdate\nresult = client.put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}\",\n\tname = None, # New registry name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}\", array(\n\tname => null, // New registry name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/edit required: true tags: - Cloud "/cloud/project/{serviceName}/containerRegistry/{registryID}/capabilities/plan": get: summary: OVH Cloud Get available plans for the current registry. security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.containerRegistry.Plan" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/capabilities/plan\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/containerRegistry/{registryID}/capabilities/plan"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/capabilities/plan/get required: true tags: - Cloud "/cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/management": get: summary: OVH Cloud List your IP restrictions applied on Harbor UI and API security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.containerRegistry.IPRestrictions" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/management\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/management"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/ipRestrictions/management/get required: true tags: - Cloud put: summary: OVH Cloud Replace IP restrictions applied on Harbor UI and API security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.containerRegistry.IPRestrictions" responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.containerRegistry.IPRestrictions" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.containerRegistry.IPRestrictions[]\nresult = client.put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/management\",\n\tdata = None, # (type: cloud.containerRegistry.IPRestrictions[])\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/management\", array(\n\tdata => null, // (type: cloud.containerRegistry.IPRestrictions[])\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/ipRestrictions/management/edit required: true tags: - Cloud "/cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/registry": get: summary: OVH Cloud List your IP restrictions applied on artifact manager component security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.containerRegistry.IPRestrictions" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/registry\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/registry"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/ipRestrictions/registry/get required: true tags: - Cloud put: summary: OVH Cloud Replace IP restrictions applied on artifact manager component (Docker, Helm, etc...) security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.containerRegistry.IPRestrictions" responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.containerRegistry.IPRestrictions" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.containerRegistry.IPRestrictions[]\nresult = client.put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/registry\",\n\tdata = None, # (type: cloud.containerRegistry.IPRestrictions[])\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/registry\", array(\n\tdata => null, // (type: cloud.containerRegistry.IPRestrictions[])\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/ipRestrictions/registry/edit required: true tags: - Cloud "/cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect": delete: summary: OVH Cloud Delete the registry's OIDC Configuration security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/openIdConnect/delete required: true tags: - Cloud get: summary: OVH Cloud Get the registry's OIDC configuration security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.containerRegistry.OIDCConfiguration" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/openIdConnect/get required: true tags: - Cloud post: summary: OVH Cloud Add or replace the registry's OIDC configuration security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.containerRegistry.OIDCPost" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.containerRegistry.OIDCPost\nresult = client.post(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect\",\n\tdeleteUsers = None, # Delete all previously created users to allow OIDC configuration (type: boolean, nullable)\n\tprovider = None, # The OIDC provider configuration (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect\", array(\n\tprovider => null, // The OIDC provider configuration (type: )\n\tdeleteUsers => null, // Delete all previously created users to allow OIDC configuration (type: boolean, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/openIdConnect/upsert required: true tags: - Cloud put: summary: OVH Cloud Edit the registry's OIDC configuration security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.containerRegistry.OIDCPut" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.containerRegistry.OIDCPut\nresult = client.put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect\",\n\tclientId = None, # The OIDC Configuration ClientID (type: string, nullable)\n\tendpoint = None, # The OIDC Configuration Endpoint (type: string, nullable)\n\tname = None, # The OIDC Configuration Name (type: string, nullable)\n\tuserClaim = None, # The OIDC Configuration UserClaim (type: string, nullable)\n\tverifyCert = None, # The OIDC Configuration VerifyCert (type: boolean, nullable)\n\tautoOnboard = None, # The OIDC Configuration AutoOnboard (type: boolean, nullable)\n\tclientSecret = None, # The OIDC Configuration Client Secret (type: string, nullable)\n\tgroupsClaim = None, # The OIDC Configuration GroupsClaim (type: string, nullable)\n\tscope = None, # The OIDC Configuration comma-separated list of Scopes (type: string, nullable)\n\tadminGroup = None, # The OIDC Configuration AdminGroup (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect\", array(\n\tuserClaim => null, // The OIDC Configuration UserClaim (type: string, nullable)\n\tverifyCert => null, // The OIDC Configuration VerifyCert (type: boolean, nullable)\n\tautoOnboard => null, // The OIDC Configuration AutoOnboard (type: boolean, nullable)\n\tclientSecret => null, // The OIDC Configuration Client Secret (type: string, nullable)\n\tclientId => null, // The OIDC Configuration ClientID (type: string, nullable)\n\tendpoint => null, // The OIDC Configuration Endpoint (type: string, nullable)\n\tname => null, // The OIDC Configuration Name (type: string, nullable)\n\tgroupsClaim => null, // The OIDC Configuration GroupsClaim (type: string, nullable)\n\tscope => null, // The OIDC Configuration comma-separated list of Scopes (type: string, nullable)\n\tadminGroup => null, // The OIDC Configuration AdminGroup (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/openIdConnect/edit required: true tags: - Cloud "/cloud/project/{serviceName}/containerRegistry/{registryID}/plan": get: summary: OVH Cloud Show the actual plan of the registry. security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.containerRegistry.Plan" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/plan\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/containerRegistry/{registryID}/plan"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/plan/get required: true tags: - Cloud put: summary: OVH Cloud Update the plan of a registry. security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.containerRegistry.PlanUpdate" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.containerRegistry.PlanUpdate\nresult = client.put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/plan\",\n\tplanID = None, # Plan ID to apply to the registry (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/plan\", array(\n\tplanID => null, // Plan ID to apply to the registry (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/plan/edit required: true tags: - Cloud "/cloud/project/{serviceName}/containerRegistry/{registryID}/users": get: summary: OVH Cloud List registry user security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.containerRegistry.User" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/users\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/containerRegistry/{registryID}/users"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/users/get required: true x-response-identifier: id x-expanded-response: CloudContainerRegistryUser tags: - Cloud post: summary: OVH Cloud Create a new registry user security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectContainerRegistryUsersCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.containerRegistry.User" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectContainerRegistryUsersCreation\nresult = client.post(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/users\",\n\temail = None, # New user email (type: string, nullable)\n\tlogin = None, # New user login (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/users\", array(\n\temail => null, // New user email (type: string, nullable)\n\tlogin => null, // New user login (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/users/create required: true tags: - Cloud "/cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}": delete: summary: OVH Cloud Delete a registry user security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userID description: UserID required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/users/delete required: true tags: - Cloud get: summary: OVH Cloud Get registry user security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userID description: UserID required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.containerRegistry.User" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/users/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}/setAsAdmin": put: summary: OVH Cloud Set the user as Admin security: - oAuth2AuthCode: [] parameters: - in: path name: registryID description: RegistryID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userID description: UserID required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.put(\"/cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}/setAsAdmin\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- put("/cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}/setAsAdmin"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:containerRegistry/users/setAsAdmin required: true tags: - Cloud "/cloud/project/{serviceName}/database/availability": get: summary: OVH Cloud Get database engines availability security: - oAuth2AuthCode: [] parameters: - in: query name: action description: Type of action on which restrict the availabilities schema: "$ref": "#/components/schemas/cloud.project.database.availability.ActionEnum" - in: query name: clusterId description: Cluster ID on which restrict the availabilities schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: query name: target description: Type of target on which restrict the availabilities schema: "$ref": "#/components/schemas/cloud.project.database.availability.TargetEnum" responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.Availability" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/availability\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/availability"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/availability/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/capabilities": get: summary: OVH Cloud Get database engines capabilities security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Capabilities" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/capabilities\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/capabilities"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/capabilities/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra": get: summary: OVH Cloud List all the cassandra clusters of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/get required: true x-expanded-response: CloudProjectDatabaseService tags: - Cloud post: summary: OVH Cloud Create a new cassandra cluster security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/cassandra\",\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription = None, # Description of the cluster (type: string)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan = None, # Plan of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/cassandra\", array(\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n\tplan => null, // Plan of the cluster (type: string)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tdescription => null, // Description of the cluster (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}": delete: summary: OVH Cloud Delete a cassandra cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/cassandra/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/delete required: true tags: - Cloud get: summary: OVH Cloud Get cassandra cluster properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing cassandra cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}\",\n\tregion = None, # Region of the cluster (type: string, nullable)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tdescription = None, # Description of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}\", array(\n\tdescription => null, // Description of the cluster (type: string)\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tregion => null, // Region of the cluster (type: string, nullable)\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan => null, // Plan of the cluster (type: string)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/advancedConfiguration": get: summary: OVH Cloud Get cassandra advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/advancedConfiguration/get required: true tags: - Cloud put: summary: OVH Cloud Update cassandra advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: map[string]string\nresult = client.put(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/advancedConfiguration\",\n\tdata = None, # (type: map[string]string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/advancedConfiguration\", array(\n\tdata => null, // (type: map[string]string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/advancedConfiguration/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/backup": get: summary: OVH Cloud List backups of the cassandra security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/backup\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/backup"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/backup/get required: true x-expanded-response: CloudProjectDatabaseBackup tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/backup/{backupId}": get: summary: OVH Cloud Get cassandra backups security: - oAuth2AuthCode: [] parameters: - in: path name: backupId description: Backup ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Backup" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/backup/{backupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/backup/{backupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/backup/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/capabilities/advancedConfiguration": get: summary: OVH Cloud Get cassandra advanced configuration fields security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.advancedConfiguration.Property" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/capabilities/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/capabilities/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/capabilities/advancedConfiguration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the cassandra service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/certificates": get: summary: OVH Cloud Retrieve the certificates of the cassandra cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Certificates" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/certificates\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/certificates"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/certificates/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/integration\",\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n\tsourceServiceId = None, # ID of the source service (type: string)\n\ttype = None, # Type of the integration (type: )\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/integration\", array(\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n\tsourceServiceId => null, // ID of the source service (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/cassandra/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction": get: summary: OVH Cloud List cassandra ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/cassandra" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/ipRestriction/get required: true x-expanded-response: CloudProjectDatabaseIpRestriction tags: - Cloud post: summary: OVH Cloud Add ip restrictions to the cassandra deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/cassandra" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestrictionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestrictionCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction\",\n\tdescription = None, # Description of the ip restriction (type: string)\n\tip = None, # Whitelisted IP (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction\", array(\n\tip => null, // Whitelisted IP (type: )\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/ipRestriction/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction/{ipBlock}": delete: summary: OVH Cloud Deletes the given IP from the restricted IPs of the cassandra deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/cassandra" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/ipRestriction/delete required: true tags: - Cloud get: summary: OVH Cloud Get cassandra ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/cassandra" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/ipRestriction/get required: true x-response-identifier: ip tags: - Cloud put: summary: OVH Cloud Changes the list of ip restrictions to the cassandra deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/cassandra" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestriction\nresult = client.put(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction/{ipBlock}\",\n\tdescription = None, # Description of the ip restriction (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/ipRestriction/{ipBlock}\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/ipRestriction/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent cassandra log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the cassandra cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the cassandra cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/cassandra/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the cassandra cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the cassandra cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/node": get: summary: OVH Cloud List nodes of the cassandra security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get cassandra nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/user": get: summary: OVH Cloud List users of the cassandra security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/user\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/user"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/user/get required: true x-expanded-response: CloudProjectDatabaseServiceUser tags: - Cloud post: summary: OVH Cloud Create a new user on the cassandra cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.UserCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/user\",\n\tname = None, # Name of the user (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/user\", array(\n\tname => null, // Name of the user (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/user/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/user/{userId}": delete: summary: OVH Cloud Delete a cassandra user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/cassandra/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/user/delete required: true tags: - Cloud get: summary: OVH Cloud Get cassandra users security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/cassandra/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/user/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/cassandra/{clusterId}/user/{userId}/credentials/reset": post: summary: OVH Cloud Resets the password of a user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/cassandra/{clusterId}/user/{userId}/credentials/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/cassandra/{clusterId}/user/{userId}/credentials/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/cassandra/user/credentials/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana": get: summary: OVH Cloud List all the grafana of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/get required: true x-expanded-response: CloudProjectDatabaseService tags: - Cloud post: summary: OVH Cloud Create a new grafana cluster security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/grafana\",\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription = None, # Description of the cluster (type: string)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan = None, # Plan of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/grafana\", array(\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription => null, // Description of the cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan => null, // Plan of the cluster (type: string)\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}": delete: summary: OVH Cloud Delete a grafana cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/grafana/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/grafana/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/delete required: true tags: - Cloud get: summary: OVH Cloud Get grafana cluster properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing grafana cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/grafana/{clusterId}\",\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tregion = None, # Region of the cluster (type: string, nullable)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tdescription = None, # Description of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/grafana/{clusterId}\", array(\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan => null, // Plan of the cluster (type: string)\n\tregion => null, // Region of the cluster (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tdescription => null, // Description of the cluster (type: string)\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/advancedConfiguration": get: summary: OVH Cloud Get grafana advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/advancedConfiguration/get required: true tags: - Cloud put: summary: OVH Cloud Update grafana advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: map[string]string\nresult = client.put(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/advancedConfiguration\",\n\tdata = None, # (type: map[string]string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/advancedConfiguration\", array(\n\tdata => null, // (type: map[string]string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/advancedConfiguration/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/backup": get: summary: OVH Cloud List backups of the grafana security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/backup\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/backup"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/backup/get required: true x-expanded-response: CloudProjectDatabaseBackup tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/backup/{backupId}": get: summary: OVH Cloud Get grafana backups security: - oAuth2AuthCode: [] parameters: - in: path name: backupId description: Backup ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Backup" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/backup/{backupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/backup/{backupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/backup/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/capabilities/advancedConfiguration": get: summary: OVH Cloud Get grafana advanced configuration fields security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.advancedConfiguration.Property" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/capabilities/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/capabilities/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/capabilities/advancedConfiguration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the grafana service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/integration\",\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n\tsourceServiceId = None, # ID of the source service (type: string)\n\ttype = None, # Type of the integration (type: )\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/integration\", array(\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n\tsourceServiceId => null, // ID of the source service (type: string)\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/grafana/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction": get: summary: OVH Cloud List grafana ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/grafana" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/ipRestriction/get required: true x-expanded-response: CloudProjectDatabaseIpRestriction tags: - Cloud post: summary: OVH Cloud Add ip restrictions to the grafana deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/grafana" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestrictionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestrictionCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction\",\n\tdescription = None, # Description of the ip restriction (type: string)\n\tip = None, # Whitelisted IP (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n\tip => null, // Whitelisted IP (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/ipRestriction/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction/{ipBlock}": delete: summary: OVH Cloud Deletes the given IP from the restricted IPs of the grafana deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/grafana" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/ipRestriction/delete required: true tags: - Cloud get: summary: OVH Cloud Get grafana ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/grafana" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/ipRestriction/get required: true x-response-identifier: ip tags: - Cloud put: summary: OVH Cloud Changes the list of ip restrictions to the grafana deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/grafana" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestriction\nresult = client.put(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction/{ipBlock}\",\n\tdescription = None, # Description of the ip restriction (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/ipRestriction/{ipBlock}\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/ipRestriction/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent grafana log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the grafana cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the grafana cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/grafana/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the grafana cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the grafana cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/node": get: summary: OVH Cloud List nodes of the grafana security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get grafana nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/user": get: summary: OVH Cloud List users of the grafana security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/user\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/user"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/user/get required: true x-expanded-response: CloudProjectDatabaseServiceUser tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/user/{userId}": get: summary: OVH Cloud Get grafana users security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/grafana/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/user/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/grafana/{clusterId}/user/{userId}/credentials/reset": post: summary: OVH Cloud Resets the password of a user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/grafana/{clusterId}/user/{userId}/credentials/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/grafana/{clusterId}/user/{userId}/credentials/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/grafana/user/credentials/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka": get: summary: OVH Cloud List all the kafka of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/get required: true x-expanded-response: CloudProjectDatabaseKafkaService tags: - Cloud post: summary: OVH Cloud Create a new kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/kafka\",\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription = None, # Description of the cluster (type: string)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan = None, # Plan of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafka\", array(\n\tdescription => null, // Description of the cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan => null, // Plan of the cluster (type: string)\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}": delete: summary: OVH Cloud Delete a kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafka/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafka/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafka cluster properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.kafka.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/kafka/{clusterId}\",\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n\tbackupTime = None, # Time on which backups start every day (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: useNodes (type: integer)\n\tschemaRegistry = None, # Defines whether the schema registry is enabled on the cluster (type: boolean)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\trestApi = None, # Defines whether the REST API is enabled on the cluster (type: boolean)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tdescription = None, # Description of the cluster (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/kafka/{clusterId}\", array(\n\tplan => null, // Plan of the cluster (type: string)\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n\tbackupTime => null, // Time on which backups start every day (type: )\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: useNodes (type: integer)\n\tschemaRegistry => null, // Defines whether the schema registry is enabled on the cluster (type: boolean)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tdescription => null, // Description of the cluster (type: string)\n\trestApi => null, // Defines whether the REST API is enabled on the cluster (type: boolean)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/acl": get: summary: OVH Cloud List acls of the kafka deprecated: true x-deprecation-date: '2022-07-13T00:00:00Z' x-deletion-date: '2023-10-13T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafka/{productID}/topicAcl" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/acl\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/acl"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/acl/get required: true x-expanded-response: CloudProjectDatabaseKafkaTopicAcl tags: - Cloud post: summary: OVH Cloud Create a new acl on the kafka cluster deprecated: true x-deprecation-date: '2022-07-13T00:00:00Z' x-deletion-date: '2023-10-13T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafka/{productID}/topicAcl" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.TopicAcl" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.TopicAcl" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.kafka.TopicAcl\nresult = client.post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/acl\",\n\tusername = None, # Username affected by this acl (type: string)\n\tpermission = None, # Permission to give to this username on this topic. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions (type: string)\n\ttopic = None, # Topic affected by this acl (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/acl\", array(\n\tpermission => null, // Permission to give to this username on this topic. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions (type: string)\n\ttopic => null, // Topic affected by this acl (type: string)\n\tusername => null, // Username affected by this acl (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/acl/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/acl/{aclId}": delete: summary: OVH Cloud Delete a kafka acl deprecated: true x-deprecation-date: '2022-07-13T00:00:00Z' x-deletion-date: '2023-10-13T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafka/{productID}/topicAcl" security: - oAuth2AuthCode: [] parameters: - in: path name: aclId description: Acl ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/acl/{aclId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafka/{clusterId}/acl/{aclId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/acl/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafka acls deprecated: true x-deprecation-date: '2022-07-13T00:00:00Z' x-deletion-date: '2023-10-13T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafka/{productID}/topicAcl" security: - oAuth2AuthCode: [] parameters: - in: path name: aclId description: Acl ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.TopicAcl" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/acl/{aclId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/acl/{aclId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/acl/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/advancedConfiguration": get: summary: OVH Cloud Get kafka advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/advancedConfiguration/get required: true tags: - Cloud put: summary: OVH Cloud Update kafka advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: map[string]string\nresult = client.put(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/advancedConfiguration\",\n\tdata = None, # (type: map[string]string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/advancedConfiguration\", array(\n\tdata => null, // (type: map[string]string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/advancedConfiguration/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/capabilities/advancedConfiguration": get: summary: OVH Cloud Get kafka advanced configuration fields security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.advancedConfiguration.Property" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/capabilities/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/capabilities/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/capabilities/advancedConfiguration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the kafka service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/certificates": get: summary: OVH Cloud Retrieve the certificates of the kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Certificates" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/certificates\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/certificates"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/certificates/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/integration\",\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n\tsourceServiceId = None, # ID of the source service (type: string)\n\ttype = None, # Type of the integration (type: )\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/integration\", array(\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n\tsourceServiceId => null, // ID of the source service (type: string)\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafka/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction": get: summary: OVH Cloud List kafka ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafka" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/ipRestriction/get required: true x-expanded-response: CloudProjectDatabaseIpRestriction tags: - Cloud post: summary: OVH Cloud Add ip restrictions to the kafka deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafka" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestrictionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestrictionCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction\",\n\tdescription = None, # Description of the ip restriction (type: string)\n\tip = None, # Whitelisted IP (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n\tip => null, // Whitelisted IP (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/ipRestriction/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction/{ipBlock}": delete: summary: OVH Cloud Deletes the given IP from the restricted IPs of the kafka deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafka" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/ipRestriction/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafka ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafka" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/ipRestriction/get required: true x-response-identifier: ip tags: - Cloud put: summary: OVH Cloud Changes the list of ip restrictions to the kafka deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafka" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestriction\nresult = client.put(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction/{ipBlock}\",\n\tdescription = None, # Description of the ip restriction (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/ipRestriction/{ipBlock}\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/ipRestriction/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent kafka log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/kafka/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/node": get: summary: OVH Cloud List nodes of the kafka security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get kafka nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/permissions": get: summary: OVH Cloud Retrieve the permissions available on the cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.Permissions" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/permissions\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/permissions"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/permissions/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl": get: summary: OVH Cloud List schema registry acls of the kafka security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/schemaRegistryAcl/get required: true x-expanded-response: CloudProjectDatabaseKafkaSchemaRegistryAcl tags: - Cloud post: summary: OVH Cloud Create a new schema registry acl on the kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.SchemaRegistryAcl" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.SchemaRegistryAcl" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.kafka.SchemaRegistryAcl\nresult = client.post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl\",\n\tusername = None, # Username affected by this acl (type: string)\n\tpermission = None, # Permission to give to this username on this resource. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions (type: string)\n\tresource = None, # Resource affected by this acl (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl\", array(\n\tpermission => null, // Permission to give to this username on this resource. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions (type: string)\n\tresource => null, // Resource affected by this acl (type: string)\n\tusername => null, // Username affected by this acl (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/schemaRegistryAcl/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl/{aclId}": delete: summary: OVH Cloud Delete a kafka schema registry acl security: - oAuth2AuthCode: [] parameters: - in: path name: aclId description: Acl ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl/{aclId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl/{aclId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/schemaRegistryAcl/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafka schema registry acls security: - oAuth2AuthCode: [] parameters: - in: path name: aclId description: Acl ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.SchemaRegistryAcl" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl/{aclId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/schemaRegistryAcl/{aclId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/schemaRegistryAcl/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/topic": get: summary: OVH Cloud List topics of the kafka security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topic\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/topic"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/topic/get required: true x-expanded-response: CloudProjectDatabaseKafkaTopic tags: - Cloud post: summary: OVH Cloud Create a new topic on the kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.TopicCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.Topic" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.kafka.TopicCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topic\",\n\tname = None, # Name of the topic (type: string)\n\tpartitions = None, # Number of partitions for this topic (type: integer)\n\treplication = None, # Number of replication for this topic (type: integer)\n\tretentionBytes = None, # Number of bytes for the retention of the data for this topic (type: integer)\n\tretentionHours = None, # Number of hours for the retention of the data for this topic (type: integer)\n\tminInsyncReplicas = None, # Minimum insync replica accepted for this topic (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topic\", array(\n\tname => null, // Name of the topic (type: string)\n\tpartitions => null, // Number of partitions for this topic (type: integer)\n\treplication => null, // Number of replication for this topic (type: integer)\n\tretentionBytes => null, // Number of bytes for the retention of the data for this topic (type: integer)\n\tretentionHours => null, // Number of hours for the retention of the data for this topic (type: integer)\n\tminInsyncReplicas => null, // Minimum insync replica accepted for this topic (type: integer)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/topic/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/topic/{topicId}": delete: summary: OVH Cloud Delete a kafka topic security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: topicId description: Topic ID required: true schema: type: string format: uuid responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topic/{topicId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafka/{clusterId}/topic/{topicId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/topic/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafka topics security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: topicId description: Topic ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.Topic" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topic/{topicId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/topic/{topicId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/topic/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Updates the topic on the kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: topicId description: Topic ID required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.Topic" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.Topic" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.kafka.Topic\nresult = client.put(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topic/{topicId}\",\n\tpartitions = None, # Number of partitions for this topic (type: integer)\n\treplication = None, # Number of replication for this topic (type: integer)\n\tretentionBytes = None, # Number of bytes for the retention of the data for this topic (type: integer)\n\tretentionHours = None, # Number of hours for the retention of the data for this topic (type: integer)\n\tminInsyncReplicas = None, # Minimum insync replica accepted for this topic (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topic/{topicId}\", array(\n\tminInsyncReplicas => null, // Minimum insync replica accepted for this topic (type: integer)\n\tpartitions => null, // Number of partitions for this topic (type: integer)\n\treplication => null, // Number of replication for this topic (type: integer)\n\tretentionBytes => null, // Number of bytes for the retention of the data for this topic (type: integer)\n\tretentionHours => null, // Number of hours for the retention of the data for this topic (type: integer)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/topic/update required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl": get: summary: OVH Cloud List topic acls of the kafka security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/topicAcl/get required: true x-expanded-response: CloudProjectDatabaseKafkaTopicAcl tags: - Cloud post: summary: OVH Cloud Create a new topic acl on the kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.TopicAcl" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.TopicAcl" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.kafka.TopicAcl\nresult = client.post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl\",\n\tpermission = None, # Permission to give to this username on this topic. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions (type: string)\n\ttopic = None, # Topic affected by this acl (type: string)\n\tusername = None, # Username affected by this acl (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl\", array(\n\tpermission => null, // Permission to give to this username on this topic. Permissions values can be retrieved using /cloud/project/{serviceName}/database/kafka/{clusterId}/permissions (type: string)\n\ttopic => null, // Topic affected by this acl (type: string)\n\tusername => null, // Username affected by this acl (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/topicAcl/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl/{aclId}": delete: summary: OVH Cloud Delete a kafka topic acl security: - oAuth2AuthCode: [] parameters: - in: path name: aclId description: Acl ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl/{aclId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl/{aclId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/topicAcl/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafka topic acls security: - oAuth2AuthCode: [] parameters: - in: path name: aclId description: Acl ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.TopicAcl" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl/{aclId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/topicAcl/{aclId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/topicAcl/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/user": get: summary: OVH Cloud List users of the kafka security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/user\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/user"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/user/get required: true x-expanded-response: CloudProjectDatabaseServiceUser tags: - Cloud post: summary: OVH Cloud Create a new user on the kafka cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.UserCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/user\",\n\tname = None, # Name of the user (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/user\", array(\n\tname => null, // Name of the user (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/user/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}": delete: summary: OVH Cloud Delete a kafka user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/user/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafka users security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/user/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}/access": get: summary: OVH Cloud Retrieve the user acces for the cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafka.user.Access" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}/access\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}/access"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/user/access/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}/credentials/reset": post: summary: OVH Cloud Resets the password of a user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}/credentials/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/kafka/{clusterId}/user/{userId}/credentials/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafka/user/credentials/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect": get: summary: OVH Cloud List all the kafkaConnect of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/get required: true x-expanded-response: CloudProjectDatabaseService tags: - Cloud post: summary: OVH Cloud Create a new kafkaConnect cluster security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect\",\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tdescription = None, # Description of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafkaConnect\", array(\n\tdescription => null, // Description of the cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan => null, // Plan of the cluster (type: string)\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}": delete: summary: OVH Cloud Delete a kafkaConnect cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafkaConnect cluster properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing kafkaConnect cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}\",\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tregion = None, # Region of the cluster (type: string, nullable)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tdescription = None, # Description of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}\", array(\n\tdescription => null, // Description of the cluster (type: string)\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan => null, // Plan of the cluster (type: string)\n\tregion => null, // Region of the cluster (type: string, nullable)\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/advancedConfiguration": get: summary: OVH Cloud Get kafkaConnect advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/advancedConfiguration/get required: true tags: - Cloud put: summary: OVH Cloud Update kafkaConnect advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: map[string]string\nresult = client.put(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/advancedConfiguration\",\n\tdata = None, # (type: map[string]string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/advancedConfiguration\", array(\n\tdata => null, // (type: map[string]string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/advancedConfiguration/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/advancedConfiguration": get: summary: OVH Cloud Get kafkaConnect advanced configuration fields security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.advancedConfiguration.Property" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/capabilities/advancedConfiguration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector": get: summary: OVH Cloud List Kafka Connect connectors security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/capabilities/connector/get required: true x-expanded-response: CloudProjectDatabaseKafkaConnectCapabilitiesConnector tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}": get: summary: OVH Cloud Get Kafka Connect connector capability security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.capabilities.Connector" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/capabilities/connector/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}/configuration": get: summary: OVH Cloud Get Kafka Connect connector configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.capabilities.connector.configuration.Property" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}/configuration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}/configuration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/capabilities/connector/configuration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}/transforms": get: summary: OVH Cloud Get Kafka Connect connector transforms security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.capabilities.connector.Transform" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}/transforms\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/connector/{connectorId}/transforms"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/capabilities/connector/transforms/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the kafkaConnect service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector": get: summary: OVH Cloud List the connectors security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/get required: true x-expanded-response: CloudProjectDatabaseKafkaConnectConnector tags: - Cloud post: summary: OVH Cloud Create a new connector security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.ConnectorCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.Connector" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.kafkaConnect.ConnectorCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector\",\n\tconfiguration = None, # Configuration of the connector (type: object)\n\tconnectorId = None, # Connector capability ID (type: string)\n\tname = None, # Name of the connector (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector\", array(\n\tname => null, // Name of the connector (type: string)\n\tconfiguration => null, // Configuration of the connector (type: object)\n\tconnectorId => null, // Connector capability ID (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}": delete: summary: OVH Cloud Delete a connector security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/delete required: true tags: - Cloud get: summary: OVH Cloud Get connector security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.Connector" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update a connector security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.Connector" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.Connector" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.kafkaConnect.Connector\nresult = client.put(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}\",\n\tconfiguration = None, # Configuration of the connector (type: object)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}\", array(\n\tconfiguration => null, // Configuration of the connector (type: object)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/pause": post: summary: OVH Cloud Pause the kafka connector execution security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/pause\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/pause"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/pause required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/restart": post: summary: OVH Cloud Restart the kafka connector execution security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/restart\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/restart"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/restart required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/resume": post: summary: OVH Cloud Resume the kafka connector execution security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/resume\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/resume"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/resume required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task": get: summary: OVH Cloud List the connector tasks security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: integer '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/task/get required: true x-expanded-response: CloudProjectDatabaseKafkaConnectConnectorTask tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task/{taskId}": get: summary: OVH Cloud Get connector task security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: taskId description: Task ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.kafkaConnect.connector.Task" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task/{taskId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task/{taskId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/task/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task/{taskId}/restart": post: summary: OVH Cloud Restart the kafka connector task execution security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectorId description: Connector ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: taskId description: Task ID required: true schema: type: integer responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task/{taskId}/restart\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/connector/{connectorId}/task/{taskId}/restart"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/connector/task/restart required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration\",\n\tsourceServiceId = None, # ID of the source service (type: string)\n\ttype = None, # Type of the integration (type: )\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration\", array(\n\tsourceServiceId => null, // ID of the source service (type: string)\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction": get: summary: OVH Cloud List kafkaConnect ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafkaConnect" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/ipRestriction/get required: true x-expanded-response: CloudProjectDatabaseIpRestriction tags: - Cloud post: summary: OVH Cloud Add ip restrictions to the kafkaConnect deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafkaConnect" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestrictionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestrictionCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction\",\n\tdescription = None, # Description of the ip restriction (type: string)\n\tip = None, # Whitelisted IP (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n\tip => null, // Whitelisted IP (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/ipRestriction/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction/{ipBlock}": delete: summary: OVH Cloud Deletes the given IP from the restricted IPs of the kafkaConnect deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafkaConnect" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/ipRestriction/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafkaConnect ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafkaConnect" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/ipRestriction/get required: true x-response-identifier: ip tags: - Cloud put: summary: OVH Cloud Changes the list of ip restrictions to the kafkaConnect deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/kafkaConnect" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestriction\nresult = client.put(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction/{ipBlock}\",\n\tdescription = None, # Description of the ip restriction (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/ipRestriction/{ipBlock}\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/ipRestriction/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent kafkaConnect log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the kafka connect cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the kafka connect cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the kafkaConnect cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the kafkaConnect cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/node": get: summary: OVH Cloud List nodes of the kafkaConnect security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get kafkaConnect nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user": get: summary: OVH Cloud List users of the kafkaConnect security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/user/get required: true x-expanded-response: CloudProjectDatabaseServiceUser tags: - Cloud post: summary: OVH Cloud Create a new user on the kafkaConnect cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.UserCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user\",\n\tname = None, # Name of the user (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user\", array(\n\tname => null, // Name of the user (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/user/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user/{userId}": delete: summary: OVH Cloud Delete a kafkaConnect user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/user/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafkaConnect users security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/user/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user/{userId}/credentials/reset": post: summary: OVH Cloud Resets the password of a user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user/{userId}/credentials/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/kafkaConnect/{clusterId}/user/{userId}/credentials/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaConnect/user/credentials/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker": get: summary: OVH Cloud List all the kafkaMirrorMaker of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/get required: true x-expanded-response: CloudProjectDatabaseService tags: - Cloud post: summary: OVH Cloud Create a new kafkaMirrorMaker security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker\",\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription = None, # Description of the cluster (type: string)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan = None, # Plan of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker\", array(\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription => null, // Description of the cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan => null, // Plan of the cluster (type: string)\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}": delete: summary: OVH Cloud Delete a kafkaMirrorMaker security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafkaMirrorMaker properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing kafkaMirrorMaker security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}\",\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tregion = None, # Region of the cluster (type: string, nullable)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tdescription = None, # Description of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}\", array(\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tplan => null, // Plan of the cluster (type: string)\n\tregion => null, // Region of the cluster (type: string, nullable)\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tdescription => null, // Description of the cluster (type: string)\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the kafkaMirrorMaker service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration\",\n\tsourceServiceId = None, # ID of the source service (type: string)\n\ttype = None, # Type of the integration (type: )\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration\", array(\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n\tsourceServiceId => null, // ID of the source service (type: string)\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent kafkaMirrorMaker log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the kafka mirror maker cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the kafka mirror maker cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the kafkaMirrorMaker security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the kafkaMirrorMaker security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/node": get: summary: OVH Cloud List nodes of the kafkaMirrorMaker security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get kafkaMirrorMaker nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication": get: summary: OVH Cloud List replication of the kafkaMirrorMaker security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/replication/get required: true x-expanded-response: CloudProjectDatabaseServiceReplication tags: - Cloud post: summary: OVH Cloud Create a new replication security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.ReplicationCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Replication" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.ReplicationCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication\",\n\temitHeartbeats = None, # Defines whether heartbeats are emitted (type: boolean)\n\ttopicExcludeList = None, # Patterns of the topics to exclude from the replication (type: array)\n\tenabled = None, # Defines whether the replication is actived (type: boolean)\n\tsyncGroupOffsets = None, # Defines whether the group offsets must be sync (type: boolean)\n\treplicationPolicyClass = None, # ReplicationPolicyClass used for the replication (type: )\n\tsourceIntegration = None, # ID of the integration source (type: string)\n\tsyncInterval = None, # Defines the interval in second between 2 sync (type: integer)\n\ttargetIntegration = None, # ID of the integration target (type: string)\n\ttopics = None, # Patterns of the topics to replicate (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication\", array(\n\temitHeartbeats => null, // Defines whether heartbeats are emitted (type: boolean)\n\ttopicExcludeList => null, // Patterns of the topics to exclude from the replication (type: array)\n\tenabled => null, // Defines whether the replication is actived (type: boolean)\n\tsyncGroupOffsets => null, // Defines whether the group offsets must be sync (type: boolean)\n\treplicationPolicyClass => null, // ReplicationPolicyClass used for the replication (type: )\n\tsourceIntegration => null, // ID of the integration source (type: string)\n\tsyncInterval => null, // Defines the interval in second between 2 sync (type: integer)\n\ttargetIntegration => null, // ID of the integration target (type: string)\n\ttopics => null, // Patterns of the topics to replicate (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/replication/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication/{replicationId}": delete: summary: OVH Cloud Delete an replication security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: replicationId description: Replication ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication/{replicationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication/{replicationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/replication/delete required: true tags: - Cloud get: summary: OVH Cloud Get kafkaMirrorMaker replication security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: replicationId description: Replication ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Replication" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication/{replicationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication/{replicationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/replication/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Updates a replication security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: replicationId description: Replication ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Replication" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Replication" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Replication\nresult = client.put(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication/{replicationId}\",\n\tenabled = None, # Defines whether the replication is actived (type: boolean)\n\temitHeartbeats = None, # Defines whether heartbeats are emitted (type: boolean)\n\treplicationPolicyClass = None, # ReplicationPolicyClass used for the replication (type: )\n\tsyncInterval = None, # Defines the interval in second between 2 sync (type: integer)\n\ttopics = None, # Patterns of the topics to replicate (type: array)\n\tsyncGroupOffsets = None, # Defines whether the group offsets must be sync (type: boolean)\n\ttopicExcludeList = None, # Patterns of the topics to exclude from the replication (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/kafkaMirrorMaker/{clusterId}/replication/{replicationId}\", array(\n\tenabled => null, // Defines whether the replication is actived (type: boolean)\n\temitHeartbeats => null, // Defines whether heartbeats are emitted (type: boolean)\n\treplicationPolicyClass => null, // ReplicationPolicyClass used for the replication (type: )\n\tsyncInterval => null, // Defines the interval in second between 2 sync (type: integer)\n\ttopics => null, // Patterns of the topics to replicate (type: array)\n\tsyncGroupOffsets => null, // Defines whether the group offsets must be sync (type: boolean)\n\ttopicExcludeList => null, // Patterns of the topics to exclude from the replication (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/kafkaMirrorMaker/replication/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator": get: summary: OVH Cloud List all the m3aggregator of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/get required: true x-expanded-response: CloudProjectDatabaseService tags: - Cloud post: summary: OVH Cloud Create a new m3aggregator security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/m3aggregator\",\n\tplan = None, # Plan of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription = None, # Description of the cluster (type: string)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/m3aggregator\", array(\n\tdescription => null, // Description of the cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan => null, // Plan of the cluster (type: string)\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}": delete: summary: OVH Cloud Delete a m3aggregator security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/delete required: true tags: - Cloud get: summary: OVH Cloud Get m3aggregator properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing m3aggregator security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}\",\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tregion = None, # Region of the cluster (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tdescription = None, # Description of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}\", array(\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan => null, // Plan of the cluster (type: string)\n\tregion => null, // Region of the cluster (type: string, nullable)\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tdescription => null, // Description of the cluster (type: string)\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the m3aggregator service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration\",\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n\tsourceServiceId = None, # ID of the source service (type: string)\n\ttype = None, # Type of the integration (type: )\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration\", array(\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n\tsourceServiceId => null, // ID of the source service (type: string)\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent m3aggregator log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the m3aggregator cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the m3aggregator cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the m3aggregator security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the m3aggregator security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/node": get: summary: OVH Cloud List nodes of the m3aggregator security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get m3aggregator nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3aggregator/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3aggregator/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/m3db": get: summary: OVH Cloud List all the m3db clusters of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/get required: true x-expanded-response: CloudProjectDatabaseService tags: - Cloud post: summary: OVH Cloud Create a new m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/m3db\",\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tdescription = None, # Description of the cluster (type: string)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/m3db\", array(\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tdescription => null, // Description of the cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n\tplan => null, // Plan of the cluster (type: string)\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}": delete: summary: OVH Cloud Delete a m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/m3db/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/m3db/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/delete required: true tags: - Cloud get: summary: OVH Cloud Get m3db cluster properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/m3db/{clusterId}\",\n\tregion = None, # Region of the cluster (type: string, nullable)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tdescription = None, # Description of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/m3db/{clusterId}\", array(\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tdescription => null, // Description of the cluster (type: string)\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tplan => null, // Plan of the cluster (type: string)\n\tregion => null, // Region of the cluster (type: string, nullable)\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/advancedConfiguration": get: summary: OVH Cloud Get m3db advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/advancedConfiguration/get required: true tags: - Cloud put: summary: OVH Cloud Update m3db advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: map[string]string\nresult = client.put(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/advancedConfiguration\",\n\tdata = None, # (type: map[string]string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/advancedConfiguration\", array(\n\tdata => null, // (type: map[string]string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/advancedConfiguration/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/backup": get: summary: OVH Cloud List backups of the m3db security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/backup\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/backup"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/backup/get required: true x-expanded-response: CloudProjectDatabaseBackup tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/backup/{backupId}": get: summary: OVH Cloud Get m3db backups security: - oAuth2AuthCode: [] parameters: - in: path name: backupId description: Backup ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Backup" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/backup/{backupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/backup/{backupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/backup/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/capabilities/advancedConfiguration": get: summary: OVH Cloud Get m3db advanced configuration fields security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.advancedConfiguration.Property" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/capabilities/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/capabilities/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/capabilities/advancedConfiguration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the m3db service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/integration\",\n\tsourceServiceId = None, # ID of the source service (type: string)\n\ttype = None, # Type of the integration (type: )\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/integration\", array(\n\tsourceServiceId => null, // ID of the source service (type: string)\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/m3db/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction": get: summary: OVH Cloud List m3db ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/m3db" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/ipRestriction/get required: true x-expanded-response: CloudProjectDatabaseIpRestriction tags: - Cloud post: summary: OVH Cloud Add ip restrictions to the m3db deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/m3db" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestrictionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestrictionCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction\",\n\tdescription = None, # Description of the ip restriction (type: string)\n\tip = None, # Whitelisted IP (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n\tip => null, // Whitelisted IP (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/ipRestriction/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction/{ipBlock}": delete: summary: OVH Cloud Deletes the given IP from the restricted IPs of the m3db deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/m3db" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/ipRestriction/delete required: true tags: - Cloud get: summary: OVH Cloud Get m3db ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/m3db" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/ipRestriction/get required: true x-response-identifier: ip tags: - Cloud put: summary: OVH Cloud Changes the list of ip restrictions to the m3db deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/m3db" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestriction\nresult = client.put(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction/{ipBlock}\",\n\tdescription = None, # Description of the ip restriction (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/ipRestriction/{ipBlock}\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/ipRestriction/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent m3db log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/m3db/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace": get: summary: OVH Cloud List namespaces of the m3db security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/namespace/get required: true x-expanded-response: CloudProjectDatabaseM3dbNamespace tags: - Cloud post: summary: OVH Cloud Create a new namespace on the m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.NamespaceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.Namespace" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.m3db.NamespaceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace\",\n\tname = None, # Name of the namespace (type: string)\n\tresolution = None, # Resolution for an aggregated namespace (type: string)\n\tretention = None, # Retention configuration (type: )\n\tsnapshotEnabled = None, # Defines whether M3db will create snapshot files for this namespace (type: boolean)\n\ttype = None, # Type of namespace (type: )\n\twritesToCommitLogEnabled = None, # Defines whether M3db will include writes to this namespace in the commit log (type: boolean)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace\", array(\n\twritesToCommitLogEnabled => null, // Defines whether M3db will include writes to this namespace in the commit log (type: boolean)\n\tname => null, // Name of the namespace (type: string)\n\tresolution => null, // Resolution for an aggregated namespace (type: string)\n\tretention => null, // Retention configuration (type: )\n\tsnapshotEnabled => null, // Defines whether M3db will create snapshot files for this namespace (type: boolean)\n\ttype => null, // Type of namespace (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/namespace/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace/{namespaceId}": delete: summary: OVH Cloud Delete m3db namespace security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: namespaceId description: Namespace ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace/{namespaceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace/{namespaceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/namespace/delete required: true tags: - Cloud get: summary: OVH Cloud Get m3db namespaces security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: namespaceId description: Namespace ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.Namespace" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace/{namespaceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace/{namespaceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/namespace/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Updates the namespace on the m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: namespaceId description: Namespace ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.Namespace" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.Namespace" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.m3db.Namespace\nresult = client.put(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace/{namespaceId}\",\n\twritesToCommitLogEnabled = None, # Defines whether M3db will include writes to this namespace in the commit log (type: boolean)\n\tresolution = None, # Resolution for an aggregated namespace (type: string, nullable)\n\tretention = None, # Retention configuration (type: )\n\tsnapshotEnabled = None, # Defines whether M3db will create snapshot files for this namespace (type: boolean)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/namespace/{namespaceId}\", array(\n\tretention => null, // Retention configuration (type: )\n\tsnapshotEnabled => null, // Defines whether M3db will create snapshot files for this namespace (type: boolean)\n\twritesToCommitLogEnabled => null, // Defines whether M3db will include writes to this namespace in the commit log (type: boolean)\n\tresolution => null, // Resolution for an aggregated namespace (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/namespace/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/node": get: summary: OVH Cloud List nodes of the m3db security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get m3db nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/user": get: summary: OVH Cloud List users of the m3db security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/user\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/user"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/user/get required: true x-expanded-response: CloudProjectDatabaseM3dbUser tags: - Cloud post: summary: OVH Cloud Create a new user on the m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.UserCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.m3db.UserCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/user\",\n\tname = None, # Name of the user (type: string)\n\tgroup = None, # Group of the user (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/user\", array(\n\tname => null, // Name of the user (type: string)\n\tgroup => null, // Group of the user (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/user/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}": delete: summary: OVH Cloud Delete m3db user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/user/delete required: true tags: - Cloud get: summary: OVH Cloud Get m3db users security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/user/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Updates the user on the m3db cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.User" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.m3db.User\nresult = client.put(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}\",\n\tgroup = None, # Group of the user (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}\", array(\n\tgroup => null, // Group of the user (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/user/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}/credentials/reset": post: summary: OVH Cloud Resets the password of a user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.m3db.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}/credentials/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/m3db/{clusterId}/user/{userId}/credentials/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/m3db/user/credentials/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql": get: summary: OVH Cloud List all the mysql of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/get required: true x-expanded-response: CloudProjectDatabaseService tags: - Cloud post: summary: OVH Cloud Create a new mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/mysql\",\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription = None, # Description of the cluster (type: string)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan = None, # Plan of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/mysql\", array(\n\tplan => null, // Plan of the cluster (type: string)\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription => null, // Description of the cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}": delete: summary: OVH Cloud Delete a mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/mysql/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/mysql/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/delete required: true tags: - Cloud get: summary: OVH Cloud Get mysql cluster properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/mysql/{clusterId}\",\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tregion = None, # Region of the cluster (type: string, nullable)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tdescription = None, # Description of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/mysql/{clusterId}\", array(\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tregion => null, // Region of the cluster (type: string, nullable)\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan => null, // Plan of the cluster (type: string)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tdescription => null, // Description of the cluster (type: string)\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/advancedConfiguration": get: summary: OVH Cloud Get mysql advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/advancedConfiguration/get required: true tags: - Cloud put: summary: OVH Cloud Update mysql advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: map[string]string\nresult = client.put(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/advancedConfiguration\",\n\tdata = None, # (type: map[string]string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/advancedConfiguration\", array(\n\tdata => null, // (type: map[string]string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/advancedConfiguration/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/backup": get: summary: OVH Cloud List backups of the mysql security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/backup\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/backup"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/backup/get required: true x-expanded-response: CloudProjectDatabaseBackup tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/backup/{backupId}": get: summary: OVH Cloud Get mysql backups security: - oAuth2AuthCode: [] parameters: - in: path name: backupId description: Backup ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Backup" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/backup/{backupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/backup/{backupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/backup/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/capabilities/advancedConfiguration": get: summary: OVH Cloud Get mysql advanced configuration fields security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.advancedConfiguration.Property" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/capabilities/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/capabilities/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/capabilities/advancedConfiguration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the mysql service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/certificates": get: summary: OVH Cloud Retrieve the certificates of the mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Certificates" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/certificates\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/certificates"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/certificates/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/currentQueries": get: summary: OVH Cloud Retrieve the current queries for the cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: limit description: Limit size of the result set returned by the pagination schema: type: integer - in: query name: offset description: Offset of the result set returned by the pagination schema: type: integer - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.CurrentQueries" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/currentQueries\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/currentQueries"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/currentQueries/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/currentQueries/cancel": post: summary: OVH Cloud Cancel the given current query of the cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.currentqueries.query.CancelRequest" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.currentqueries.query.CancelResponse" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.currentqueries.query.CancelRequest\nresult = client.post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/currentQueries/cancel\",\n\tpid = None, # Database server connection ID (type: integer)\n\tterminate = None, # Request immediate termination instead of soft cancel (type: boolean)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/currentQueries/cancel\", array(\n\tpid => null, // Database server connection ID (type: integer)\n\tterminate => null, // Request immediate termination instead of soft cancel (type: boolean)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/currentQueries/cancel required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/database": get: security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/database\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/database"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/database/get required: true x-expanded-response: CloudProjectDatabaseServiceDatabase tags: - Cloud post: summary: OVH Cloud Create a new database on the mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Database" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Database" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Database\nresult = client.post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/database\",\n\tname = None, # Database name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/database\", array(\n\tname => null, // Database name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/database/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/database/{databaseId}": delete: summary: OVH Cloud Delete a mysql database security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: databaseId description: Database ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/database/{databaseId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/mysql/{clusterId}/database/{databaseId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/database/delete required: true tags: - Cloud get: summary: OVH Cloud Get the database for the mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: databaseId description: Database ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Database" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/database/{databaseId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/database/{databaseId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/database/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/enableWrites": post: summary: OVH Cloud Enable temporary write permission on readonly lock mysql service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.TemporaryWriteDeadline" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/enableWrites\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/mysql/{clusterId}/enableWrites"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/enableWrites required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/integration\",\n\ttype = None, # Type of the integration (type: )\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n\tsourceServiceId = None, # ID of the source service (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/integration\", array(\n\tsourceServiceId => null, // ID of the source service (type: string)\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/mysql/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction": get: summary: OVH Cloud List mysql ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/mysql" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/ipRestriction/get required: true x-expanded-response: CloudProjectDatabaseIpRestriction tags: - Cloud post: summary: OVH Cloud Add ip restrictions to the mysql deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/mysql" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestrictionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestrictionCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction\",\n\tdescription = None, # Description of the ip restriction (type: string)\n\tip = None, # Whitelisted IP (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction\", array(\n\tip => null, // Whitelisted IP (type: )\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/ipRestriction/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction/{ipBlock}": delete: summary: OVH Cloud Deletes the given IP from the restricted IPs of the mysql deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/mysql" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/ipRestriction/delete required: true tags: - Cloud get: summary: OVH Cloud Get mysql ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/mysql" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/ipRestriction/get required: true x-response-identifier: ip tags: - Cloud put: summary: OVH Cloud Changes the list of ip restrictions to the mysql deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/mysql" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestriction\nresult = client.put(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction/{ipBlock}\",\n\tdescription = None, # Description of the ip restriction (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/ipRestriction/{ipBlock}\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/ipRestriction/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent mysql log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/mysql/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/node": get: summary: OVH Cloud List nodes of the mysql security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get mysql nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/queryStatistics": get: summary: OVH Cloud Retrieve the query statistics for the cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: limit description: Limit size of the result set returned by the pagination schema: type: integer - in: query name: offset description: Offset of the result set returned by the pagination schema: type: integer - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.mysql.QueryStatistics" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/queryStatistics\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/queryStatistics"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/queryStatistics/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/queryStatistics/reset": post: summary: OVH Cloud Reset the query statistics of the cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/queryStatistics/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/mysql/{clusterId}/queryStatistics/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/queryStatistics/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/user": get: summary: OVH Cloud List users of the mysql security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/user\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/user"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/user/get required: true x-expanded-response: CloudProjectDatabaseServiceUser tags: - Cloud post: summary: OVH Cloud Create a new user on the mysql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.UserCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/user\",\n\tname = None, # Name of the user (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/user\", array(\n\tname => null, // Name of the user (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/user/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/user/{userId}": delete: summary: OVH Cloud Delete a mysql user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/mysql/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/user/delete required: true tags: - Cloud get: summary: OVH Cloud Get mysql users security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/mysql/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/user/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/mysql/{clusterId}/user/{userId}/credentials/reset": post: summary: OVH Cloud Resets the password of a user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/mysql/{clusterId}/user/{userId}/credentials/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/mysql/{clusterId}/user/{userId}/credentials/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/mysql/user/credentials/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch": get: summary: OVH Cloud List all the opensearch of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/get required: true x-expanded-response: CloudProjectDatabaseOpensearchService tags: - Cloud post: summary: OVH Cloud Create a new opensearch cluster security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/opensearch\",\n\tdescription = None, # Description of the cluster (type: string)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan = None, # Plan of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/opensearch\", array(\n\tdescription => null, // Description of the cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan => null, // Plan of the cluster (type: string)\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}": delete: summary: OVH Cloud Delete a opensearch cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/opensearch/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/delete required: true tags: - Cloud get: summary: OVH Cloud Get opensearch cluster properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing opensearch cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.opensearch.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}\",\n\taclsEnabled = None, # Defines whether the acls are enabled on the cluster (type: boolean)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tdescription = None, # Description of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tplan = None, # Plan of the cluster (type: string)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}\", array(\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\taclsEnabled => null, // Defines whether the acls are enabled on the cluster (type: boolean)\n\tdescription => null, // Description of the cluster (type: string)\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tplan => null, // Plan of the cluster (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/advancedConfiguration": get: summary: OVH Cloud Get opensearch advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/advancedConfiguration/get required: true tags: - Cloud put: summary: OVH Cloud Update opensearch advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: map[string]string\nresult = client.put(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/advancedConfiguration\",\n\tdata = None, # (type: map[string]string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/advancedConfiguration\", array(\n\tdata => null, // (type: map[string]string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/advancedConfiguration/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/backup": get: summary: OVH Cloud List backups of the opensearch security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/backup\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/backup"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/backup/get required: true x-expanded-response: CloudProjectDatabaseBackup tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/backup/{backupId}": get: summary: OVH Cloud Get opensearch backups security: - oAuth2AuthCode: [] parameters: - in: path name: backupId description: Backup ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Backup" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/backup/{backupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/backup/{backupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/backup/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/capabilities/advancedConfiguration": get: summary: OVH Cloud Get opensearch advanced configuration fields security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.advancedConfiguration.Property" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/capabilities/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/capabilities/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/capabilities/advancedConfiguration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the opensearch service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/index": get: summary: OVH Cloud List indexes of the opensearch security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/index\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/index"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/index/get required: true x-expanded-response: CloudProjectDatabaseOpensearchIndex tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/index/{indexId}": delete: summary: OVH Cloud Delete an opensearch index security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: indexId description: Index ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/index/{indexId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/opensearch/{clusterId}/index/{indexId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/index/delete required: true tags: - Cloud get: summary: OVH Cloud Get opensearch index security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: indexId description: Index ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.Index" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/index/{indexId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/index/{indexId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/index/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/integration\",\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n\tsourceServiceId = None, # ID of the source service (type: string)\n\ttype = None, # Type of the integration (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/integration\", array(\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n\tsourceServiceId => null, // ID of the source service (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/opensearch/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction": get: summary: OVH Cloud List opensearch ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/opensearch" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/ipRestriction/get required: true x-expanded-response: CloudProjectDatabaseIpRestriction tags: - Cloud post: summary: OVH Cloud Add ip restrictions to the opensearch deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/opensearch" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestrictionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestrictionCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction\",\n\tdescription = None, # Description of the ip restriction (type: string)\n\tip = None, # Whitelisted IP (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction\", array(\n\tip => null, // Whitelisted IP (type: )\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/ipRestriction/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction/{ipBlock}": delete: summary: OVH Cloud Deletes the given IP from the restricted IPs of the opensearch deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/opensearch" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/ipRestriction/delete required: true tags: - Cloud get: summary: OVH Cloud Get opensearch ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/opensearch" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/ipRestriction/get required: true x-response-identifier: ip tags: - Cloud put: summary: OVH Cloud Changes the list of ip restrictions to the opensearch deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/opensearch" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestriction\nresult = client.put(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction/{ipBlock}\",\n\tdescription = None, # Description of the ip restriction (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/ipRestriction/{ipBlock}\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/ipRestriction/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent opensearch log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the opensearch cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the opensearch cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/opensearch/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the opensearch cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the opensearch cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/node": get: summary: OVH Cloud List nodes of the opensearch security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get opensearch nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern": get: summary: OVH Cloud List patterns of the opensearch security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/pattern/get required: true x-expanded-response: CloudProjectDatabaseOpensearchPattern tags: - Cloud post: summary: OVH Cloud Create a new pattern on the opensearch cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.Pattern" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.Pattern" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.opensearch.Pattern\nresult = client.post(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern\",\n\tmaxIndexCount = None, # Maximum number of index for this pattern (type: integer)\n\tpattern = None, # Pattern format (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern\", array(\n\tmaxIndexCount => null, // Maximum number of index for this pattern (type: integer)\n\tpattern => null, // Pattern format (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/pattern/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern/{patternId}": delete: summary: OVH Cloud Delete an opensearch pattern security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: patternId description: Pattern ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern/{patternId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern/{patternId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/pattern/delete required: true tags: - Cloud get: summary: OVH Cloud Get opensearch patterns security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: patternId description: Pattern ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.Pattern" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern/{patternId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/pattern/{patternId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/pattern/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/permissions": get: summary: OVH Cloud Retrieve the opensearch permissions values security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.Permissions" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/permissions\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/permissions"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/permissions/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/user": get: summary: OVH Cloud List users of the opensearch security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/user\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/user"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/user/get required: true x-expanded-response: CloudProjectDatabaseOpensearchUser tags: - Cloud post: summary: OVH Cloud Create a new user on the opensearch cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.UserCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.opensearch.UserCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/user\",\n\tacls = None, # Acls of the user (type: array)\n\tname = None, # Name of the user (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/user\", array(\n\tacls => null, // Acls of the user (type: array)\n\tname => null, // Name of the user (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/user/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}": delete: summary: OVH Cloud Delete a opensearch user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/user/delete required: true tags: - Cloud get: summary: OVH Cloud Get opensearch users security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/user/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update a user on the opensearch cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.User" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.opensearch.User\nresult = client.put(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}\",\n\tacls = None, # Acls of the user (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}\", array(\n\tacls => null, // Acls of the user (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/user/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}/credentials/reset": post: summary: OVH Cloud Resets the password of a user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.opensearch.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}/credentials/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}/credentials/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/opensearch/user/credentials/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql": get: summary: OVH Cloud List all the postgresql of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/get required: true x-expanded-response: CloudProjectDatabaseService tags: - Cloud post: summary: OVH Cloud Create a new postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql\",\n\tplan = None, # Plan of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription = None, # Description of the cluster (type: string)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/postgresql\", array(\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription => null, // Description of the cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan => null, // Plan of the cluster (type: string)\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}": delete: summary: OVH Cloud Delete a postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/postgresql/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/delete required: true tags: - Cloud get: summary: OVH Cloud Get postgresql cluster properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}\",\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tregion = None, # Region of the cluster (type: string, nullable)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tdescription = None, # Description of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}\", array(\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan => null, // Plan of the cluster (type: string)\n\tregion => null, // Region of the cluster (type: string, nullable)\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tdescription => null, // Description of the cluster (type: string)\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/advancedConfiguration": get: summary: OVH Cloud Get postgresql advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/advancedConfiguration/get required: true tags: - Cloud put: summary: OVH Cloud Update postgresql advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: map[string]string\nresult = client.put(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/advancedConfiguration\",\n\tdata = None, # (type: map[string]string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/advancedConfiguration\", array(\n\tdata => null, // (type: map[string]string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/advancedConfiguration/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/backup": get: summary: OVH Cloud List backups of the postgresql security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/backup\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/backup"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/backup/get required: true x-expanded-response: CloudProjectDatabaseBackup tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/backup/{backupId}": get: summary: OVH Cloud Get postgresql backups security: - oAuth2AuthCode: [] parameters: - in: path name: backupId description: Backup ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Backup" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/backup/{backupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/backup/{backupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/backup/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/capabilities/advancedConfiguration": get: summary: OVH Cloud Get postgresql advanced configuration fields security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.advancedConfiguration.Property" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/capabilities/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/capabilities/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/capabilities/advancedConfiguration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the postgresql service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/certificates": get: summary: OVH Cloud Retrieve the certificates of the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Certificates" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/certificates\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/certificates"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/certificates/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool": get: security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/connectionPool/get required: true x-expanded-response: CloudProjectDatabasePostgresqlConnectionPool tags: - Cloud post: summary: OVH Cloud Create a new connectionPool on the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.postgresql.ConnectionPoolCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.postgresql.ConnectionPool" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.postgresql.ConnectionPoolCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool\",\n\tname = None, # Name of the connection pool (type: string)\n\tsize = None, # Size of the connection pool (type: integer)\n\tuserId = None, # User authorized to connect to the pool, if none all the users are allowed (type: string, nullable)\n\tdatabaseId = None, # Database used for the connection pool (type: string)\n\tmode = None, # Connection mode to the connection pool (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool\", array(\n\tmode => null, // Connection mode to the connection pool (type: )\n\tname => null, // Name of the connection pool (type: string)\n\tsize => null, // Size of the connection pool (type: integer)\n\tuserId => null, // User authorized to connect to the pool, if none all the users are allowed (type: string, nullable)\n\tdatabaseId => null, // Database used for the connection pool (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/connectionPool/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool/{connectionPoolId}": delete: summary: OVH Cloud Delete a postgresql connectionPool security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectionPoolId description: Connection pool ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool/{connectionPoolId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool/{connectionPoolId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/connectionPool/delete required: true tags: - Cloud get: summary: OVH Cloud Get the connectionPool for the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectionPoolId description: Connection pool ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.postgresql.ConnectionPool" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool/{connectionPoolId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool/{connectionPoolId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/connectionPool/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update a connectionPool on the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: connectionPoolId description: Connection pool ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.postgresql.ConnectionPool" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.postgresql.ConnectionPool" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.postgresql.ConnectionPool\nresult = client.put(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool/{connectionPoolId}\",\n\tdatabaseId = None, # Database used for the connection pool (type: string)\n\tsize = None, # Size of the connection pool (type: integer)\n\tuserId = None, # User authorized to connect to the pool, if none all the users are allowed (type: string, nullable)\n\tmode = None, # Connection mode to the connection pool (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/connectionPool/{connectionPoolId}\", array(\n\tuserId => null, // User authorized to connect to the pool, if none all the users are allowed (type: string, nullable)\n\tmode => null, // Connection mode to the connection pool (type: )\n\tdatabaseId => null, // Database used for the connection pool (type: string)\n\tsize => null, // Size of the connection pool (type: integer)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/connectionPool/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/currentQueries": get: summary: OVH Cloud Retrieve the current queries for the cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: limit description: Limit size of the result set returned by the pagination schema: type: integer - in: query name: offset description: Offset of the result set returned by the pagination schema: type: integer - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.CurrentQueries" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/currentQueries\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/currentQueries"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/currentQueries/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/currentQueries/cancel": post: summary: OVH Cloud Cancel the given current query of the cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.currentqueries.query.CancelRequest" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.currentqueries.query.CancelResponse" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.currentqueries.query.CancelRequest\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/currentQueries/cancel\",\n\tterminate = None, # Request immediate termination instead of soft cancel (type: boolean)\n\tpid = None, # Database server connection ID (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/currentQueries/cancel\", array(\n\tpid => null, // Database server connection ID (type: integer)\n\tterminate => null, // Request immediate termination instead of soft cancel (type: boolean)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/currentQueries/cancel required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/database": get: security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/database\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/database"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/database/get required: true x-expanded-response: CloudProjectDatabaseServiceDatabase tags: - Cloud post: summary: OVH Cloud Create a new database on the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Database" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Database" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Database\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/database\",\n\tname = None, # Database name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/database\", array(\n\tname => null, // Database name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/database/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/database/{databaseId}": delete: summary: OVH Cloud Delete a postgresql database security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: databaseId description: Database ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/database/{databaseId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/postgresql/{clusterId}/database/{databaseId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/database/delete required: true tags: - Cloud get: summary: OVH Cloud Get the database for the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: databaseId description: Database ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Database" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/database/{databaseId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/database/{databaseId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/database/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/enableWrites": post: summary: OVH Cloud Enable temporary write permission on readonly lock postgresql service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.TemporaryWriteDeadline" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/enableWrites\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/postgresql/{clusterId}/enableWrites"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/enableWrites required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/integration\",\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n\tsourceServiceId = None, # ID of the source service (type: string)\n\ttype = None, # Type of the integration (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/integration\", array(\n\tsourceServiceId => null, // ID of the source service (type: string)\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/postgresql/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction": get: summary: OVH Cloud List postgresql ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/postgresql" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/ipRestriction/get required: true x-expanded-response: CloudProjectDatabaseIpRestriction tags: - Cloud post: summary: OVH Cloud Add ip restrictions to the postgresql deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/postgresql" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestrictionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestrictionCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction\",\n\tip = None, # Whitelisted IP (type: )\n\tdescription = None, # Description of the ip restriction (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n\tip => null, // Whitelisted IP (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/ipRestriction/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction/{ipBlock}": delete: summary: OVH Cloud Deletes the given IP from the restricted IPs of the postgresql deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/postgresql" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/ipRestriction/delete required: true tags: - Cloud get: summary: OVH Cloud Get postgresql ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/postgresql" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/ipRestriction/get required: true x-response-identifier: ip tags: - Cloud put: summary: OVH Cloud Changes the list of ip restrictions to the postgresql deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/postgresql" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestriction\nresult = client.put(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction/{ipBlock}\",\n\tdescription = None, # Description of the ip restriction (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/ipRestriction/{ipBlock}\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/ipRestriction/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent postgresql log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/postgresql/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/node": get: summary: OVH Cloud List nodes of the postgresql security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get postgresql nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/queryStatistics": get: summary: OVH Cloud Retrieve the query statistics for the cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: limit description: Limit size of the result set returned by the pagination schema: type: integer - in: query name: offset description: Offset of the result set returned by the pagination schema: type: integer - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.postgresql.QueryStatistics" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/queryStatistics\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/queryStatistics"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/queryStatistics/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/queryStatistics/reset": post: summary: OVH Cloud Reset the query statistics of the cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/queryStatistics/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/postgresql/{clusterId}/queryStatistics/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/queryStatistics/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/roles": get: summary: OVH Cloud Get postgresql roles security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/roles\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/roles"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/roles/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/user": get: summary: OVH Cloud List users of the postgresql security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/user\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/user"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/user/get required: true x-expanded-response: CloudProjectDatabaseServiceUserWithRoles tags: - Cloud post: summary: OVH Cloud Create a new user on the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithRolesCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPasswordAndRoles" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.UserWithRolesCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/user\",\n\tname = None, # Name of the user (type: string)\n\troles = None, # Roles the user belongs to (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/user\", array(\n\tname => null, // Name of the user (type: string)\n\troles => null, // Roles the user belongs to (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/user/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}": delete: summary: OVH Cloud Delete a postgresql user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/user/delete required: true tags: - Cloud get: summary: OVH Cloud Get postgresql users security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithRoles" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/user/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Updates the user on the postgresql cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithRoles" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithRoles" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.UserWithRoles\nresult = client.put(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}\",\n\troles = None, # Roles the user belongs to (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}\", array(\n\troles => null, // Roles the user belongs to (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/user/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}/credentials/reset": post: summary: OVH Cloud Resets the password of a user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.UserWithPasswordAndRoles" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}/credentials/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/postgresql/{clusterId}/user/{userId}/credentials/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/postgresql/user/credentials/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis": get: summary: OVH Cloud List all the redis of the project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/get required: true x-expanded-response: CloudProjectDatabaseService tags: - Cloud post: summary: OVH Cloud Create a new redis cluster security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.ServiceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.ServiceCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/redis\",\n\tdescription = None, # Description of the cluster (type: string)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: time, nullable)\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tplan = None, # Plan of the cluster (type: string)\n\tbackup = None, # Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk = None, # Disk attributes of the cluster (type: )\n\tnodesList = None, # List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId = None, # Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom = None, # Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern = None, # Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId = None, # Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/redis\", array(\n\tplan => null, // Plan of the cluster (type: string)\n\tbackup => null, // Backup from which the new service is created. DEPRECATED: use forkFrom (type: cloud.project.database.service.creation.BackupFork, nullable)\n\tdisk => null, // Disk attributes of the cluster (type: )\n\tnodesList => null, // List of nodes in the cluster, not compatible with nodesPattern (type: array, nullable)\n\tsubnetId => null, // Private subnet ID in which the cluster is (type: string, nullable)\n\tforkFrom => null, // Backup from which the new service is created (type: cloud.project.database.service.creation.ForkFrom, nullable)\n\tnodesPattern => null, // Pattern definition of the nodes in the cluster, not compatible with nodesList (type: cloud.project.database.service.NodePattern, nullable)\n\tnetworkId => null, // Private network ID in which the cluster is (type: string, nullable)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: time, nullable)\n\tdescription => null, // Description of the cluster (type: string)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: time, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/redis/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}": delete: summary: OVH Cloud Delete a redis cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/redis/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/redis/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/delete required: true tags: - Cloud get: summary: OVH Cloud Get redis cluster properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update an existing redis cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.Service\nresult = client.put(\"/cloud/project/{serviceName}/database/redis/{clusterId}\",\n\tversion = None, # Version of the engine deployed on the cluster (type: string)\n\tbackupTime = None, # Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan = None, # Plan of the cluster (type: string)\n\tregion = None, # Region of the cluster (type: string, nullable)\n\tstorage = None, # Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tipRestrictions = None, # IP Blocks authorized to access to the cluster (type: array)\n\tdescription = None, # Description of the cluster (type: string)\n\tdisk = None, # Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups = None, # Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime = None, # Time on which maintenances can start every day (type: )\n\tflavor = None, # The VM flavor used for this cluster (type: string)\n\tnodeNumber = None, # Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/redis/{clusterId}\", array(\n\tdescription => null, // Description of the cluster (type: string)\n\tdisk => null, // Disk attributes of the cluster. DEPRECATED: use storage (type: )\n\tbackups => null, // Information related to the backups, null if the engine does not support backups (type: cloud.project.database.service.Backup, nullable)\n\tmaintenanceTime => null, // Time on which maintenances can start every day (type: )\n\tflavor => null, // The VM flavor used for this cluster (type: string)\n\tnodeNumber => null, // Number of nodes in the cluster. DEPRECATED: use nodes (type: integer)\n\tbackupTime => null, // Time on which backups start every day. DEPRECATED: use backups.time (type: )\n\tplan => null, // Plan of the cluster (type: string)\n\tregion => null, // Region of the cluster (type: string, nullable)\n\tstorage => null, // Storage attributes of the cluster (type: cloud.project.database.service.Storage, nullable)\n\tversion => null, // Version of the engine deployed on the cluster (type: string)\n\tipRestrictions => null, // IP Blocks authorized to access to the cluster (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/redis/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/advancedConfiguration": get: summary: OVH Cloud Get redis advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/advancedConfiguration/get required: true tags: - Cloud put: summary: OVH Cloud Update redis advanced configuration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: type: object additionalProperties: type: string responses: '200': description: successful operation content: application/json: schema: type: object additionalProperties: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: map[string]string\nresult = client.put(\"/cloud/project/{serviceName}/database/redis/{clusterId}/advancedConfiguration\",\n\tdata = None, # (type: map[string]string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/redis/{clusterId}/advancedConfiguration\", array(\n\tdata => null, // (type: map[string]string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/redis/advancedConfiguration/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/backup": get: summary: OVH Cloud List backups of the redis security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/backup\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/backup"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/backup/get required: true x-expanded-response: CloudProjectDatabaseBackup tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/backup/{backupId}": get: summary: OVH Cloud Get redis backups security: - oAuth2AuthCode: [] parameters: - in: path name: backupId description: Backup ID required: true schema: type: string format: uuid - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Backup" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/backup/{backupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/backup/{backupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/backup/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/advancedConfiguration": get: summary: OVH Cloud Get redis advanced configuration fields security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.advancedConfiguration.Property" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/advancedConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/advancedConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/capabilities/advancedConfiguration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/categories": get: summary: OVH Cloud Get available categories in the redis service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/categories\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/categories"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/capabilities/categories/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/commands": get: summary: OVH Cloud Get available commands in the redis service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/commands\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/commands"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/capabilities/commands/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/integration": get: summary: OVH Cloud Get integration capabilities related to the redis service security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.capabilities.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/capabilities/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/capabilities/integration/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/integration": get: summary: OVH Cloud List integrations security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/integration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/integration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/integration/get required: true x-expanded-response: CloudProjectDatabaseServiceIntegration tags: - Cloud post: summary: OVH Cloud Create a new integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.service.Integration\nresult = client.post(\"/cloud/project/{serviceName}/database/redis/{clusterId}/integration\",\n\tsourceServiceId = None, # ID of the source service (type: string)\n\ttype = None, # Type of the integration (type: )\n\tdestinationServiceId = None, # ID of the destination service (type: string)\n\tparameters = None, # Parameters for the integration (type: object, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/redis/{clusterId}/integration\", array(\n\tparameters => null, // Parameters for the integration (type: object, nullable)\n\tsourceServiceId => null, // ID of the source service (type: string)\n\ttype => null, // Type of the integration (type: )\n\tdestinationServiceId => null, // ID of the destination service (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/redis/integration/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/integration/{integrationId}": delete: summary: OVH Cloud Delete an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/redis/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/redis/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/integration/delete required: true tags: - Cloud get: summary: OVH Cloud Get an integration security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: integrationId description: Integration ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Integration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/integration/{integrationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/integration/{integrationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/integration/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction": get: summary: OVH Cloud List redis ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/redis" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/ipRestriction/get required: true x-expanded-response: CloudProjectDatabaseIpRestriction tags: - Cloud post: summary: OVH Cloud Add ip restrictions to the redis deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/redis" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestrictionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestrictionCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction\",\n\tdescription = None, # Description of the ip restriction (type: string)\n\tip = None, # Whitelisted IP (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n\tip => null, // Whitelisted IP (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/redis/ipRestriction/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction/{ipBlock}": delete: summary: OVH Cloud Deletes the given IP from the restricted IPs of the redis deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/redis" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/ipRestriction/delete required: true tags: - Cloud get: summary: OVH Cloud Get redis ip restrictions deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/redis" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction/{ipBlock}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction/{ipBlock}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/ipRestriction/get required: true x-response-identifier: ip tags: - Cloud put: summary: OVH Cloud Changes the list of ip restrictions to the redis deprecated: true x-deprecation-date: '2022-12-15T00:00:00Z' x-deletion-date: '2023-03-15T00:00:00Z' x-replacement-route: "/1.0/cloud/project/{serviceName}/database/redis" security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: ipBlock description: Ip block required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.IpRestriction" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.IpRestriction\nresult = client.put(\"/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction/{ipBlock}\",\n\tdescription = None, # Description of the ip restriction (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/redis/{clusterId}/ipRestriction/{ipBlock}\", array(\n\tdescription => null, // Description of the ip restriction (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/redis/ipRestriction/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/logs": get: summary: OVH Cloud Retrieve the most recent redis log messages (limited to 1000) security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.database.service.LogEntry" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/logs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/logs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/logs/get required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/maintenance": get: summary: OVH Cloud List maintenances for the redis cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/maintenance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/maintenance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/maintenance/get required: true x-expanded-response: CloudProjectDatabaseServiceMaintenance tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/maintenance/{maintenanceId}": get: summary: OVH Cloud Get the maintenance for the redis cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/maintenance/{maintenanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/maintenance/{maintenanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/maintenance/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/maintenance/{maintenanceId}/apply": post: summary: OVH Cloud Apply the maintenance security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: maintenanceId description: Maintenance ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Maintenance" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/redis/{clusterId}/maintenance/{maintenanceId}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/redis/{clusterId}/maintenance/{maintenanceId}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/maintenance/apply required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/metric": get: summary: OVH Cloud List available metrics for the redis cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: query name: extended description: Display DB specific metrics schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/metric\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/metric"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/metric/get required: true x-expanded-response: CloudProjectDatabaseServiceMetric tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/metric/{metricName}": get: summary: OVH Cloud Get the metric values for the redis cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: metricName description: Metric name required: true schema: type: string - in: query name: period description: The period of time to query metrics for required: true schema: "$ref": "#/components/schemas/cloud.project.database.service.MetricPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Metric" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/metric/{metricName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/metric/{metricName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/metric/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/node": get: summary: OVH Cloud List nodes of the redis security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/node/get required: true x-expanded-response: CloudProjectDatabaseServiceNode tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/node/{nodeId}": get: summary: OVH Cloud Get redis nodes security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: nodeId description: Node ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.service.Node" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/user": get: summary: OVH Cloud List users of the redis security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/user\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/user"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/user/get required: true x-expanded-response: CloudProjectDatabaseRedisUser tags: - Cloud post: summary: OVH Cloud Create a new user on the redis cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.redis.UserCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.redis.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.redis.UserCreation\nresult = client.post(\"/cloud/project/{serviceName}/database/redis/{clusterId}/user\",\n\tcategories = None, # Categories of the user (type: array)\n\tchannels = None, # Channels of the user (type: array)\n\tcommands = None, # Commands of the user (type: array)\n\tkeys = None, # Keys of the user (type: array)\n\tname = None, # Name of the user (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/database/redis/{clusterId}/user\", array(\n\tcommands => null, // Commands of the user (type: array)\n\tkeys => null, // Keys of the user (type: array)\n\tname => null, // Name of the user (type: string)\n\tcategories => null, // Categories of the user (type: array)\n\tchannels => null, // Channels of the user (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/redis/user/create required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}": delete: summary: OVH Cloud Delete a redis user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/user/delete required: true tags: - Cloud get: summary: OVH Cloud Get redis users security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.redis.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/user/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update a user on the redis cluster security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.redis.User" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.redis.User" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.database.redis.User\nresult = client.put(\"/cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}\",\n\tkeys = None, # Keys of the user (type: array)\n\tcategories = None, # Categories of the user (type: array)\n\tchannels = None, # Channels of the user (type: array)\n\tcommands = None, # Commands of the user (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}\", array(\n\tcategories => null, // Categories of the user (type: array)\n\tchannels => null, // Channels of the user (type: array)\n\tcommands => null, // Commands of the user (type: array)\n\tkeys => null, // Keys of the user (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:database/redis/user/edit required: true tags: - Cloud "/cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}/credentials/reset": post: summary: OVH Cloud Resets the password of a user security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.redis.UserWithPassword" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}/credentials/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/database/redis/{clusterId}/user/{userId}/credentials/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/redis/user/credentials/reset required: true tags: - Cloud "/cloud/project/{serviceName}/database/service": get: summary: OVH Cloud List database services of the project security: - oAuth2AuthCode: [] parameters: - in: query name: category description: Category on which restrict the search on services schema: "$ref": "#/components/schemas/cloud.project.database.engine.CategoryEnum" - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/service\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/service"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/service/get required: true x-expanded-response: CloudProjectDatabaseService tags: - Cloud "/cloud/project/{serviceName}/database/service/{clusterId}": get: summary: OVH Cloud Get service cluster properties security: - oAuth2AuthCode: [] parameters: - in: path name: clusterId description: Cluster ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.database.Service" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::AtLeastOneNode: value: class: Client::BadRequest::AtLeastOneNode message: At least one node must be specified Client::BadRequest::FlavorDiskSizeTooLow: value: class: Client::BadRequest::FlavorDiskSizeTooLow message: Requested flavor {{.flavor}} does not offer enough disk space. It has {{.flavorDisk}} GB while at least {{.currentDisk}} is required Client::BadRequest::NoUpdate: value: class: Client::BadRequest::NoUpdate message: No update required Client::BadRequest::NodesFlavorMismatch: value: class: Client::BadRequest::NodesFlavorMismatch message: All the nodes must have the same flavor Client::BadRequest::NodesRegionMismatch: value: class: Client::BadRequest::NodesRegionMismatch message: All the nodes must be in the same region Client::BadRequest::NotEnoughNodes: value: class: Client::BadRequest::NotEnoughNodes message: Minimum number of nodes for your offer is {{.minimum}} Client::BadRequest::OnlyNodeListOrPattern: value: class: Client::BadRequest::OnlyNodeListOrPattern message: You can only specify either nodeList or nodePattern, not both Client::BadRequest::TooManyNodes: value: class: Client::BadRequest::TooManyNodes message: Maximum number of nodes for your offer is {{.maximum}} Client::BadRequest::UserInvalidNameFormat: value: class: Client::BadRequest::UserInvalidNameFormat message: Username cannot contain any of '{{.forbidden}}' '401': description: Error 401 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Unauthorized::InvalidAuthToken: value: class: Client::Unauthorized::InvalidAuthToken message: Invalid authorization token '404': description: Error 404 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::NotFound::AvailabilityDoesNotExistAnymore: value: class: Client::NotFound::AvailabilityDoesNotExistAnymore message: Your offer is not available anymore Client::NotFound::AvailabilityNotFound: value: class: Client::NotFound::AvailabilityNotFound message: Availability {{.availability}} does not exist Client::NotFound::BackupNotFound: value: class: Client::NotFound::BackupNotFound message: Backup {{.backup}} does not exist Client::NotFound::BillingNotFound: value: class: Client::NotFound::BillingNotFound message: Billing {{.billing}} does not exist Client::NotFound::EngineNameNotFound: value: class: Client::NotFound::EngineNameNotFound message: Engine {{.name}} does not exist Client::NotFound::FlavorNameNotFound: value: class: Client::NotFound::FlavorNameNotFound message: Flavor {{.flavor}} does not exist Client::NotFound::InsertIpRestrictionsMultipleServices: value: class: Client::NotFound::InsertIpRestrictionsMultipleServices message: You can only add ip restrictions for one service at a time Client::NotFound::InvalidMetricName: value: class: Client::NotFound::InvalidMetricName message: An invalid metric {{.metric}} was specified Client::NotFound::InvalidNodeNumber: value: class: Client::NotFound::InvalidNodeNumber message: Invalid number of nodes {{.number}} Client::NotFound::IpRestrictionAlreadyExists: value: class: Client::NotFound::IpRestrictionAlreadyExists message: Ip restriction {{.ip}} is set on your service Client::NotFound::IpRestrictionIDNotFound: value: class: Client::NotFound::IpRestrictionIDNotFound message: Ip restriction {{.id}} does not exist Client::NotFound::IpRestrictionInvalidFormat: value: class: Client::NotFound::IpRestrictionInvalidFormat message: "{{.ip}} is not a valid ip restriction" Client::NotFound::IpRestrictionNotFound: value: class: Client::NotFound::IpRestrictionNotFound message: Ip restriction {{.ip}} does not exist Client::NotFound::NoMatchingAvailability: value: class: Client::NotFound::NoMatchingAvailability message: No offer matches your expectations, please refer to the availability endpoint Client::NotFound::NodeNameNotFound: value: class: Client::NotFound::NodeNameNotFound message: Node {{.name}} does not exist Client::NotFound::NodeNotFound: value: class: Client::NotFound::NodeNotFound message: Node {{.node}} does not exist Client::NotFound::OrganizationNotFound: value: class: Client::NotFound::OrganizationNotFound message: Organization {{.organization}} does not exist Client::NotFound::PlanInvalidUpgrade: value: class: Client::NotFound::PlanInvalidUpgrade message: You cannot upgrade plan {{.current}} to {{.expected}} Client::NotFound::PlanNotFound: value: class: Client::NotFound::PlanNotFound message: Plan {{.plan}} does not exist Client::NotFound::RegionNotFound: value: class: Client::NotFound::RegionNotFound message: Region {{.region}} does not exist Client::NotFound::RoleNotFound: value: class: Client::NotFound::RoleNotFound message: Role {{.role}} does not exist Client::NotFound::ServiceNotFound: value: class: Client::NotFound::ServiceNotFound message: Service {{.service}} does not exist Client::NotFound::SslCertificateNotFound: value: class: Client::NotFound::SslCertificateNotFound message: Certificate {{.sslCertificate}} does not exist Client::NotFound::UserNotFound: value: class: Client::NotFound::UserNotFound message: User {{.user}} does not exist Client::NotFound::VersionNotFound: value: class: Client::NotFound::VersionNotFound message: Version {{.version}} does not exist '409': description: Error 409 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Conflict::ServiceLocked: value: class: Client::Conflict::ServiceLocked message: Service {{.service}} is locked in read-or-delete-only mode Client::Conflict::ServiceNotReady: value: class: Client::Conflict::ServiceNotReady message: Service {{.service}} is not in state READY Client::Conflict::ServiceOnlyOneModification: value: class: Client::Conflict::ServiceOnlyOneModification message: You can only ask for one modification at a time x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/database/service/{clusterId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/database/service/{clusterId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:database/service/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/flavor": get: summary: OVH Cloud Get flavors security: - oAuth2AuthCode: [] parameters: - in: query name: region description: Flavor region schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.flavor.Flavor" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/flavor\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/flavor"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:flavor/get required: true x-response-identifier: id x-expanded-response: CloudFlavorFlavor tags: - Cloud "/cloud/project/{serviceName}/flavor/{flavorId}": get: summary: OVH Cloud Get flavor security: - oAuth2AuthCode: [] parameters: - in: path name: flavorId description: Flavor ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.flavor.Flavor" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/flavor/{flavorId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/flavor/{flavorId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:flavor/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/image": get: summary: OVH Cloud Get images security: - oAuth2AuthCode: [] parameters: - in: query name: flavorType description: Get compatible images with flavor type schema: type: string - in: query name: osType description: Image OS schema: "$ref": "#/components/schemas/cloud.image.OSTypeEnum" - in: query name: region description: Image region schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.image.Image" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/image\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/image"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:image/get required: true x-response-identifier: id x-expanded-response: CloudImageImage tags: - Cloud "/cloud/project/{serviceName}/image/{imageId}": get: summary: OVH Cloud Get image security: - oAuth2AuthCode: [] parameters: - in: path name: imageId description: Image ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.image.Image" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/image/{imageId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/image/{imageId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:image/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/instance": get: summary: OVH Cloud Get instance security: - oAuth2AuthCode: [] parameters: - in: query name: region description: Instance region schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.instance.Instance" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/instance\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/instance"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/get required: true x-response-identifier: id tags: - Cloud post: summary: OVH Cloud Create a new instance security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectInstanceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.InstanceDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectInstanceCreation\nresult = client.post(\"/cloud/project/{serviceName}/instance\",\n\tname = None, # Instance name (type: string)\n\tuserData = None, # Configuration information or scripts to use upon launch (type: string, nullable)\n\tgroupId = None, # Start instance in group (type: string, nullable)\n\tnetworks = None, # Create network interfaces (type: array, nullable)\n\tautobackup = None, # Create an autobackup workflow after instance start up (type: cloud.instance.AutoBackup, nullable)\n\tsshKeyId = None, # SSH keypair id (type: string, nullable)\n\tflavorId = None, # Instance flavor id (type: string)\n\tmonthlyBilling = None, # Active monthly billing (type: boolean, nullable)\n\tregion = None, # Instance region (type: string)\n\tvolumeId = None, # Specify a volume id to boot from it (type: string, nullable)\n\timageId = None, # Instance image id (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/instance\", array(\n\tregion => null, // Instance region (type: string)\n\tvolumeId => null, // Specify a volume id to boot from it (type: string, nullable)\n\timageId => null, // Instance image id (type: string, nullable)\n\tflavorId => null, // Instance flavor id (type: string)\n\tmonthlyBilling => null, // Active monthly billing (type: boolean, nullable)\n\tgroupId => null, // Start instance in group (type: string, nullable)\n\tnetworks => null, // Create network interfaces (type: array, nullable)\n\tautobackup => null, // Create an autobackup workflow after instance start up (type: cloud.instance.AutoBackup, nullable)\n\tsshKeyId => null, // SSH keypair id (type: string, nullable)\n\tname => null, // Instance name (type: string)\n\tuserData => null, // Configuration information or scripts to use upon launch (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:instance/create required: true tags: - Cloud "/cloud/project/{serviceName}/instance/bulk": post: summary: OVH Cloud Create multiple instances security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectInstanceBulkCreation" responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.instance.Instance" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectInstanceBulkCreation\nresult = client.post(\"/cloud/project/{serviceName}/instance/bulk\",\n\tflavorId = None, # Instance flavor id (type: string)\n\tsshKeyId = None, # SSH keypair id (type: string, nullable)\n\tnetworks = None, # Create network interfaces (type: array, nullable)\n\tgroupId = None, # Start instance in group (type: string, nullable)\n\tmonthlyBilling = None, # Active monthly billing (type: boolean, nullable)\n\timageId = None, # Instance image id (type: string, nullable)\n\tregion = None, # Instance region (type: string)\n\tuserData = None, # Configuration information or scripts to use upon launch (type: string, nullable)\n\tvolumeId = None, # Specify a volume id to boot from it (type: string, nullable)\n\tname = None, # Instance name (type: string)\n\tautobackup = None, # Create an autobackup workflow after instance start up (type: cloud.instance.AutoBackup, nullable)\n\tnumber = None, # Number of instances you want to create (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/instance/bulk\", array(\n\tsshKeyId => null, // SSH keypair id (type: string, nullable)\n\tnetworks => null, // Create network interfaces (type: array, nullable)\n\tgroupId => null, // Start instance in group (type: string, nullable)\n\tmonthlyBilling => null, // Active monthly billing (type: boolean, nullable)\n\timageId => null, // Instance image id (type: string, nullable)\n\tflavorId => null, // Instance flavor id (type: string)\n\tuserData => null, // Configuration information or scripts to use upon launch (type: string, nullable)\n\tvolumeId => null, // Specify a volume id to boot from it (type: string, nullable)\n\tname => null, // Instance name (type: string)\n\tautobackup => null, // Create an autobackup workflow after instance start up (type: cloud.instance.AutoBackup, nullable)\n\tnumber => null, // Number of instances you want to create (type: integer)\n\tregion => null, // Instance region (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:instance/bulk/create required: true tags: - Cloud "/cloud/project/{serviceName}/instance/group": get: summary: OVH Cloud Get the detail of a group security: - oAuth2AuthCode: [] parameters: - in: query name: region description: Instance region schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.instancegroup.InstanceGroup" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/instance/group\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/instance/group"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/group/get required: true x-response-identifier: id x-expanded-response: CloudInstancegroupInstanceGroup tags: - Cloud post: summary: OVH Cloud Create a group security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectInstanceGroupCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instancegroup.InstanceGroup" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectInstanceGroupCreation\nresult = client.post(\"/cloud/project/{serviceName}/instance/group\",\n\tname = None, # instance group name (type: string)\n\tregion = None, # Instance region (type: string)\n\ttype = None, # Instance group type (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/instance/group\", array(\n\tname => null, // instance group name (type: string)\n\tregion => null, // Instance region (type: string)\n\ttype => null, // Instance group type (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:instance/group/create required: true tags: - Cloud "/cloud/project/{serviceName}/instance/group/{groupId}": delete: summary: OVH Cloud Delete a group security: - oAuth2AuthCode: [] parameters: - in: path name: groupId description: Group ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/instance/group/{groupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/instance/group/{groupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/group/delete required: true tags: - Cloud get: summary: OVH Cloud Get all groups security: - oAuth2AuthCode: [] parameters: - in: path name: groupId description: Group ID required: true schema: type: string - in: query name: region description: Instance region schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instancegroup.InstanceGroup" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/instance/group/{groupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/instance/group/{groupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/group/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}": delete: summary: OVH Cloud Delete an instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/instance/{instanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/instance/{instanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/delete required: true tags: - Cloud get: summary: OVH Cloud Get instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.InstanceDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/instance/{instanceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/instance/{instanceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Alter an instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectInstanceUpdate" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectInstanceUpdate\nresult = client.put(\"/cloud/project/{serviceName}/instance/{instanceId}\",\n\tinstanceName = None, # Instance new name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/instance/{instanceId}\", array(\n\tinstanceName => null, // Instance new name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:instance/edit required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/activeMonthlyBilling": post: summary: OVH Cloud Activate monthly billing on instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.InstanceDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/activeMonthlyBilling\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/instance/{instanceId}/activeMonthlyBilling"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/activeMonthlyBilling required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/applicationAccess": post: summary: OVH Cloud Return initial credentials of applications installed from public image security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.ApplicationAccess" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/applicationAccess\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/instance/{instanceId}/applicationAccess"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/applicationAccess/create required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/interface": get: summary: OVH Cloud Get interfaces security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.instanceInterface.Interface" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/instance/{instanceId}/interface\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/instance/{instanceId}/interface"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/interface/get required: true x-response-identifier: id x-expanded-response: CloudInstanceInterfaceInterface tags: - Cloud post: summary: OVH Cloud Create interface on an instance and attached it to a network security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectInstanceInterfaceCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instanceInterface.Interface" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectInstanceInterfaceCreation\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/interface\",\n\tnetworkId = None, # Network id (type: string)\n\tip = None, # Static ip (Can only be defined for private networks) (type: ip, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/instance/{instanceId}/interface\", array(\n\tip => null, // Static ip (Can only be defined for private networks) (type: ip, nullable)\n\tnetworkId => null, // Network id (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:instance/interface/create required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/interface/{interfaceId}": delete: summary: OVH Cloud Delete an interface security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: interfaceId description: Interface ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/instance/{instanceId}/interface/{interfaceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/instance/{instanceId}/interface/{interfaceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/interface/delete required: true tags: - Cloud get: summary: OVH Cloud Get interface security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: interfaceId description: Interface ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instanceInterface.Interface" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/instance/{instanceId}/interface/{interfaceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/instance/{instanceId}/interface/{interfaceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/interface/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/monitoring": get: summary: OVH Cloud Return many statistics about the virtual machine for a given period security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: query name: period description: The period the statistics are fetched for required: true schema: "$ref": "#/components/schemas/cloud.instance.MetricsPeriodEnum" - in: path name: serviceName description: Service name required: true schema: type: string - in: query name: type description: The type of statistic to be fetched required: true schema: "$ref": "#/components/schemas/cloud.instance.MetricsTypeEnum" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.InstanceMetrics" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/instance/{instanceId}/monitoring\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/instance/{instanceId}/monitoring"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/monitoring/get required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/reboot": post: summary: OVH Cloud Reboot an instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectInstanceRebootCreation" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectInstanceRebootCreation\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/reboot\",\n\ttype = None, # Reboot type (default soft) (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/instance/{instanceId}/reboot\", array(\n\ttype => null, // Reboot type (default soft) (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:instance/reboot required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/reinstall": post: summary: OVH Cloud Reinstall an instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectInstanceReinstallCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.InstanceDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectInstanceReinstallCreation\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/reinstall\",\n\timageId = None, # Image to reinstall (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/instance/{instanceId}/reinstall\", array(\n\timageId => null, // Image to reinstall (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:instance/reinstall required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/rescueMode": post: summary: OVH Cloud Enable or disable rescue mode security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectInstanceRescueModeCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.RescueAdminPassword" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectInstanceRescueModeCreation\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/rescueMode\",\n\timageId = None, # Image to boot on (type: string, nullable)\n\trescue = None, # Enable rescue mode (type: boolean)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/instance/{instanceId}/rescueMode\", array(\n\timageId => null, // Image to boot on (type: string, nullable)\n\trescue => null, // Enable rescue mode (type: boolean)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:instance/rescueMode/create required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/resize": post: summary: OVH Cloud Migrate your instance to another flavor security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectInstanceResizeCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.InstanceDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectInstanceResizeCreation\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/resize\",\n\tflavorId = None, # Flavor id (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/instance/{instanceId}/resize\", array(\n\tflavorId => null, // Flavor id (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:instance/resize required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/resume": post: summary: OVH Cloud Resume a suspended instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/resume\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/instance/{instanceId}/resume"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/resume required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/shelve": post: summary: OVH Cloud Shelve an instance description: Shelve an instance. The resources dedicated to the Public Cloud instance are released. The data of the local storage will be stored, the duration of the operation depends on the size of the local disk. The instance can be unshelved at any time. Meanwhile hourly instances will not be billed. The Snapshot Storage used to store the instance's data will be billed. security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/shelve\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/instance/{instanceId}/shelve"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/shelve required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/snapshot": post: summary: OVH Cloud Snapshot an instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectInstanceSnapshotCreation" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectInstanceSnapshotCreation\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/snapshot\",\n\tsnapshotName = None, # Snapshot name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/instance/{instanceId}/snapshot\", array(\n\tsnapshotName => null, // Snapshot name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:instance/snapshot required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/start": post: summary: OVH Cloud Start an instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/start\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/instance/{instanceId}/start"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/start required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/stop": post: summary: OVH Cloud Stop an instance description: Stop an instance. The resources dedicated to the Public Cloud instances are still reserved. The instance can be restarted at any time. Meanwhile, the same price is charged for the instance. security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/stop\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/instance/{instanceId}/stop"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/stop required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/unshelve": post: summary: OVH Cloud Unshelve an instance description: Unshelve an instance. The resources dedicated to the Public Cloud instance are restored. The duration of the operation depends on the size of the local disk. Instance billing will get back to normal and the snapshot used to store the instance's data will be deleted. security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/unshelve\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/instance/{instanceId}/unshelve"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/unshelve required: true tags: - Cloud "/cloud/project/{serviceName}/instance/{instanceId}/vnc": post: summary: OVH Cloud Get VNC access to your instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.InstanceVnc" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/instance/{instanceId}/vnc\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/instance/{instanceId}/vnc"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:instance/vnc/create required: true tags: - Cloud "/cloud/project/{serviceName}/ip": get: summary: OVH Cloud Get ips security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.ip.CloudIp" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/ip\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/ip"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:ip/get required: true tags: - Cloud "/cloud/project/{serviceName}/ip/failover": get: summary: OVH Cloud Get failover ips security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.ip.FailoverIp" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/ip/failover\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/ip/failover"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:ip/failover/get required: true x-response-identifier: id x-expanded-response: CloudIpFailoverIp tags: - Cloud "/cloud/project/{serviceName}/ip/failover/{id}": get: summary: OVH Cloud Get failover ip security: - oAuth2AuthCode: [] parameters: - in: path name: id description: Id required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.ip.FailoverIp" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/ip/failover/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/ip/failover/{id}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:ip/failover/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/ip/failover/{id}/attach": post: summary: OVH Cloud Attach failover ip to an instance security: - oAuth2AuthCode: [] parameters: - in: path name: id description: Id required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectIpFailoverAttachCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.ip.FailoverIp" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectIpFailoverAttachCreation\nresult = client.post(\"/cloud/project/{serviceName}/ip/failover/{id}/attach\",\n\tinstanceId = None, # Attach failover ip to instance (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/ip/failover/{id}/attach\", array(\n\tinstanceId => null, // Attach failover ip to instance (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:ip/failover/attach required: true tags: - Cloud "/cloud/project/{serviceName}/kube": get: summary: OVH Cloud List your managed Kubernetes clusters security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/get required: true x-expanded-response: CloudKubeCluster tags: - Cloud post: summary: OVH Cloud Create a new managed Kubernetes cluster security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.Cluster" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeCreation\nresult = client.post(\"/cloud/project/{serviceName}/kube\",\n\tcustomization = None, # Kubernetes cluster customization (type: cloud.ProjectKubeCustomization, nullable)\n\tloadBalancersSubnetId = None, # OpenStack subnet ID that the load balancers will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId and nodesSubnetId are also set (type: string)\n\tnodesSubnetId = None, # OpenStack subnet ID that the cluster nodes will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId is also set. If unspecified, it will be selected automatically when the first node is created. (type: string)\n\tprivateNetworkId = None, # OpenStack private network ID that the cluster will use. Optional, can only be set on cluster creation or reset. If unspecified, the cluster will use the public network. (type: string)\n\tupdatePolicy = None, # Enum values for UpdatePolicy (type: cloud.kube.UpdatePolicyEnum, nullable)\n\tprivateNetworkConfiguration = None, # The private network configuration. (type: )\n\tversion = None, # Kubernetes version to install (type: )\n\tkubeProxyMode = None, # Selected mode for kube-proxy (type: )\n\tregion = None, # Kubernetes OpenStack region (type: string)\n\tname = None, # Kubernetes cluster name (type: string)\n\tnodepool = None, # Nodepool to initialize with cluster creation (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/kube\", array(\n\tversion => null, // Kubernetes version to install (type: )\n\tkubeProxyMode => null, // Selected mode for kube-proxy (type: )\n\tregion => null, // Kubernetes OpenStack region (type: string)\n\tname => null, // Kubernetes cluster name (type: string)\n\tnodepool => null, // Nodepool to initialize with cluster creation (type: )\n\tprivateNetworkConfiguration => null, // The private network configuration. (type: )\n\tloadBalancersSubnetId => null, // OpenStack subnet ID that the load balancers will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId and nodesSubnetId are also set (type: string)\n\tnodesSubnetId => null, // OpenStack subnet ID that the cluster nodes will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId is also set. If unspecified, it will be selected automatically when the first node is created. (type: string)\n\tprivateNetworkId => null, // OpenStack private network ID that the cluster will use. Optional, can only be set on cluster creation or reset. If unspecified, the cluster will use the public network. (type: string)\n\tupdatePolicy => null, // Enum values for UpdatePolicy (type: cloud.kube.UpdatePolicyEnum, nullable)\n\tcustomization => null, // Kubernetes cluster customization (type: cloud.ProjectKubeCustomization, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/create required: true tags: - Cloud "/cloud/project/{serviceName}/kube/regions": get: summary: OVH Cloud List Kubernetes available regions deprecated: true x-deprecation-date: '2020-06-10T00:00:00Z' x-deletion-date: '2020-10-01T00:00:00Z' x-replacement-route: "/cloud/project/{serviceName}/capabilities/kube/regions" security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/regions\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/regions"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/regions/get required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}": delete: summary: OVH Cloud Delete your managed Kubernetes cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/kube/{kubeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/kube/{kubeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/delete required: true tags: - Cloud get: summary: OVH Cloud Get information about your managed Kubernetes cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.Cluster" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update information about your managed Kubernetes cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeUpdate" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeUpdate\nresult = client.put(\"/cloud/project/{serviceName}/kube/{kubeId}\",\n\tupdatePolicy = None, # Enum values for UpdatePolicy (type: )\n\tname = None, # Cluster new name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/kube/{kubeId}\", array(\n\tupdatePolicy => null, // Enum values for UpdatePolicy (type: )\n\tname => null, // Cluster new name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/edit required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/auditLogs": post: summary: OVH Cloud Generate a temporary URL to retrieve audit logs deprecated: true x-deprecation-date: '2024-01-30T00:00:00Z' x-deletion-date: '2024-04-01T00:00:00Z' security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/dbaas.logs.TemporaryLogsLink" x-badges: - color: red label: Deprecated, will be removed x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/kube/{kubeId}/auditLogs\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/kube/{kubeId}/auditLogs"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/auditLogs/create required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/customization": get: summary: OVH Cloud Get cluster customization security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeCustomization" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/customization\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/customization"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/customization/get required: true tags: - Cloud put: summary: OVH Cloud Update cluster customization security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeCustomization" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.ResponseMessage" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeCustomization\nresult = client.put(\"/cloud/project/{serviceName}/kube/{kubeId}/customization\",\n\tapiServer = None, # Kubernetes cluster api server customization (type: cloud.ProjectKubeCustomizationAPIServer, nullable)\n\tkubeProxy = None, # Kubernetes cluster kube-proxy customization (type: cloud.ProjectKubeCustomizationKubeProxy, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/kube/{kubeId}/customization\", array(\n\tapiServer => null, // Kubernetes cluster api server customization (type: cloud.ProjectKubeCustomizationAPIServer, nullable)\n\tkubeProxy => null, // Kubernetes cluster kube-proxy customization (type: cloud.ProjectKubeCustomizationKubeProxy, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/customization/edit required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/flavors": get: summary: OVH Cloud List all flavors available security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.kube.Flavor" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/flavors\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/flavors"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/flavors/get required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions": get: summary: OVH Cloud List your ip restrictions on your cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/ipRestrictions/get required: true tags: - Cloud post: summary: OVH Cloud Append a list of ip restrictions on your cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeIpRestrictionUpsert" responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeIpRestrictionUpsert\nresult = client.post(\"/cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions\",\n\tips = None, # List of ips to add to the cluster api-server restrictions (format with /subnet available) (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions\", array(\n\tips => null, // List of ips to add to the cluster api-server restrictions (format with /subnet available) (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/ipRestrictions/create required: true tags: - Cloud put: summary: OVH Cloud Remove the current list and add a list of ip restrictions on your cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeIpRestrictionUpsert" responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/ipBlock" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeIpRestrictionUpsert\nresult = client.put(\"/cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions\",\n\tips = None, # List of ips to add to the cluster api-server restrictions (format with /subnet available) (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions\", array(\n\tips => null, // List of ips to add to the cluster api-server restrictions (format with /subnet available) (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/ipRestrictions/edit required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions/{ip}": delete: summary: OVH Cloud Delete an ip restriction from your cluster security: - oAuth2AuthCode: [] parameters: - in: path name: ip description: Ip required: true schema: "$ref": "#/components/schemas/ipBlock" - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions/{ip}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/kube/{kubeId}/ipRestrictions/{ip}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/ipRestrictions/delete required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/kubeconfig": post: summary: OVH Cloud Generate kubeconfig file security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.Kubeconfig" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/kube/{kubeId}/kubeconfig\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/kube/{kubeId}/kubeconfig"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/kubeconfig/create required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/kubeconfig/reset": post: summary: 'OVH Cloud Reset kubeconfig: Certificates will be regenerated, nodes will be reinstalled' security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/kube/{kubeId}/kubeconfig/reset\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/kube/{kubeId}/kubeconfig/reset"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/kubeconfig/reset required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/log/url": post: summary: OVH Cloud Generate a temporary URL to retrieve logs security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/dbaas.logs.LogUrlCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/dbaas.logs.TemporaryLogsLink" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: dbaas.logs.LogUrlCreation\nresult = client.post(\"/cloud/project/{serviceName}/kube/{kubeId}/log/url\",\n\tkind = None, # Log kind name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/kube/{kubeId}/log/url\", array(\n\tkind => null, // Log kind name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/log/url/create required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/metrics/etcdUsage": get: summary: OVH Cloud List available metrics for this cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.EtcdUsage" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/metrics/etcdUsage\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/metrics/etcdUsage"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/metrics/etcdUsage/get required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/node": get: summary: OVH Cloud List your nodes security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.kube.Node" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/node\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/node"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/node/get required: true x-response-identifier: id x-expanded-response: CloudKubeNode tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/node/{nodeId}": delete: summary: OVH Cloud Delete a specific node on your cluster description: Delete a specific node on your cluster. This will also decrease by one the desirednodes value of its nodepool. security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: nodeId description: Node ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/kube/{kubeId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/kube/{kubeId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/node/delete required: true tags: - Cloud get: summary: OVH Cloud Get information on a specific node on your cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: nodeId description: Node ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.Node" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/node/{nodeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/node/{nodeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/node/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/nodepool": get: summary: OVH Cloud List your nodepools security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.kube.NodePool" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/nodepool\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/nodepool"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/nodepool/get required: true x-response-identifier: id x-expanded-response: CloudKubeNodePool tags: - Cloud post: summary: OVH Cloud Create a nodepool on your cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeNodePoolCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.NodePool" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeNodePoolCreation\nresult = client.post(\"/cloud/project/{serviceName}/kube/{kubeId}/nodepool\",\n\tdesiredNodes = None, # Number of nodes to instantiate (1 by default) (type: integer)\n\tantiAffinity = None, # Enable anti affinity groups for nodes in the pool (type: boolean, nullable)\n\tname = None, # NodePool name (type: string)\n\tmaxNodes = None, # Higher limit you accept for the desiredNodes value (100 by default) (type: integer)\n\ttemplate = None, # NodePool template to apply to each children nodes (type: )\n\tmonthlyBilled = None, # Enable monthly billing for nodes in the pool (type: boolean, nullable)\n\tminNodes = None, # Lower limit you accept for the desiredNodes value (0 by default) (type: integer)\n\tautoscale = None, # Enable the auto-scaling on the pool (type: boolean, nullable)\n\tautoscaling = None, # Autoscaling customization parameters (type: )\n\tflavorName = None, # Nodes flavor (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/kube/{kubeId}/nodepool\", array(\n\tautoscale => null, // Enable the auto-scaling on the pool (type: boolean, nullable)\n\tautoscaling => null, // Autoscaling customization parameters (type: )\n\tflavorName => null, // Nodes flavor (type: string)\n\ttemplate => null, // NodePool template to apply to each children nodes (type: )\n\tmonthlyBilled => null, // Enable monthly billing for nodes in the pool (type: boolean, nullable)\n\tminNodes => null, // Lower limit you accept for the desiredNodes value (0 by default) (type: integer)\n\tname => null, // NodePool name (type: string)\n\tmaxNodes => null, // Higher limit you accept for the desiredNodes value (100 by default) (type: integer)\n\tdesiredNodes => null, // Number of nodes to instantiate (1 by default) (type: integer)\n\tantiAffinity => null, // Enable anti affinity groups for nodes in the pool (type: boolean, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/nodepool/create required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}": delete: summary: OVH Cloud Delete a nodepool from your cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: nodePoolId description: Node pool ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/nodepool/delete required: true tags: - Cloud get: summary: OVH Cloud Get information on a specific nodepool on your cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: nodePoolId description: Node pool ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.NodePool" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/nodepool/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update your nodepool information security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: nodePoolId description: Node pool ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeNodePoolUpdate" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeNodePoolUpdate\nresult = client.put(\"/cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}\",\n\tdesiredNodes = None, # New number of nodes wanted in the nodepool (type: integer)\n\tmaxNodes = None, # New maximal number of nodes wanted in the nodepool (type: integer)\n\tminNodes = None, # New minimal number of nodes wanted in the nodepool (type: integer)\n\tnodesToRemove = None, # List of specific node IDs, openstack instance IDs or Node.Spec.providerIDs to delete during downscale (type: array)\n\ttemplate = None, # NodePool template to apply to each children nodes (type: )\n\tautoscale = None, # Enable the auto-scaling on the pool (type: boolean, nullable)\n\tautoscaling = None, # Autoscaling customization parameters (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}\", array(\n\ttemplate => null, // NodePool template to apply to each children nodes (type: )\n\tautoscale => null, // Enable the auto-scaling on the pool (type: boolean, nullable)\n\tautoscaling => null, // Autoscaling customization parameters (type: )\n\tdesiredNodes => null, // New number of nodes wanted in the nodepool (type: integer)\n\tmaxNodes => null, // New maximal number of nodes wanted in the nodepool (type: integer)\n\tminNodes => null, // New minimal number of nodes wanted in the nodepool (type: integer)\n\tnodesToRemove => null, // List of specific node IDs, openstack instance IDs or Node.Spec.providerIDs to delete during downscale (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/nodepool/edit required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}/nodes": get: summary: OVH Cloud List all nodes contained in a nodepool security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: nodePoolId description: Node pool ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.kube.Node" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}/nodes\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/nodepool/{nodePoolId}/nodes"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/nodepool/nodes/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/openIdConnect": delete: summary: OVH Cloud Remove OpenIdConnect integration from APIServer security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/kube/{kubeId}/openIdConnect\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/kube/{kubeId}/openIdConnect"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/openIdConnect/delete required: true tags: - Cloud get: summary: OVH Cloud Get openIdConnect integration parameters security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.OpenIdConnect" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/openIdConnect\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/openIdConnect"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/openIdConnect/get required: true tags: - Cloud post: summary: OVH Cloud Configure APIServer for OpenIdConnect security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeOpenIdConnectCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.OpenIdConnect" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeOpenIdConnectCreation\nresult = client.post(\"/cloud/project/{serviceName}/kube/{kubeId}/openIdConnect\",\n\tusernameClaim = None, # JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins. (type: string, nullable)\n\tsigningAlgorithms = None, # The signing algorithms accepted. Default is \"RS256\". (type: array, nullable)\n\tusernamePrefix = None, # Prefix prepended to username claims to prevent clashes with existing names (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. If this field isn't set and oidcUsernameClaim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of oidcIssuerUrl. The value - can be used to disable all prefixing. (type: string, nullable)\n\tgroupsPrefix = None, # Prefix prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra. (type: string, nullable)\n\tclientId = None, # Client ID (type: string)\n\tissuerUrl = None, # Issuer URL (type: string)\n\tcaContent = None, # Content of the certificate for the CA, in base64 format, that signed your identity provider's web certificate. Defaults to the host's root CAs. (type: string, nullable)\n\tgroupsClaim = None, # JWT claim to use as the user's group. If the claim is present it must be an array of strings. (type: array, nullable)\n\trequiredClaim = None, # key=value pairs that describe required claims in the ID Token. If set, the claims are verified to be present in the ID Token with a matching value. (type: array, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/kube/{kubeId}/openIdConnect\", array(\n\tcaContent => null, // Content of the certificate for the CA, in base64 format, that signed your identity provider's web certificate. Defaults to the host's root CAs. (type: string, nullable)\n\tgroupsClaim => null, // JWT claim to use as the user's group. If the claim is present it must be an array of strings. (type: array, nullable)\n\trequiredClaim => null, // key=value pairs that describe required claims in the ID Token. If set, the claims are verified to be present in the ID Token with a matching value. (type: array, nullable)\n\tclientId => null, // Client ID (type: string)\n\tissuerUrl => null, // Issuer URL (type: string)\n\tsigningAlgorithms => null, // The signing algorithms accepted. Default is \"RS256\". (type: array, nullable)\n\tusernamePrefix => null, // Prefix prepended to username claims to prevent clashes with existing names (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. If this field isn't set and oidcUsernameClaim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of oidcIssuerUrl. The value - can be used to disable all prefixing. (type: string, nullable)\n\tgroupsPrefix => null, // Prefix prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra. (type: string, nullable)\n\tusernameClaim => null, // JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins. (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/openIdConnect/create required: true tags: - Cloud put: summary: OVH Cloud Update parameters and reconfigure APIServer security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeOpenIdConnectUpdate" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeOpenIdConnectUpdate\nresult = client.put(\"/cloud/project/{serviceName}/kube/{kubeId}/openIdConnect\",\n\tcaContent = None, # Content of the certificate for the CA, in base64 format, that signed your identity provider's web certificate. Defaults to the host's root CAs. (type: string, nullable)\n\tgroupsPrefix = None, # Prefix prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra. (type: string, nullable)\n\tusernamePrefix = None, # Prefix prepended to username claims to prevent clashes with existing names (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. If this field isn't set and oidcUsernameClaim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of oidcIssuerUrl. The value - can be used to disable all prefixing. (type: string, nullable)\n\tissuerUrl = None, # Issuer URL (type: string)\n\trequiredClaim = None, # key=value pairs that describe required claims in the ID Token. If set, the claims are verified to be present in the ID Token with a matching value. (type: array, nullable)\n\tsigningAlgorithms = None, # The signing algorithms accepted. Default is \"RS256\". (type: array, nullable)\n\tusernameClaim = None, # JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins. (type: string, nullable)\n\tclientId = None, # Client ID (type: string)\n\tgroupsClaim = None, # JWT claim to use as the user's group. If the claim is present it must be an array of strings. (type: array, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/kube/{kubeId}/openIdConnect\", array(\n\tusernamePrefix => null, // Prefix prepended to username claims to prevent clashes with existing names (such as system: users). For example, the value oidc: will create usernames like oidc:jane.doe. If this field isn't set and oidcUsernameClaim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of oidcIssuerUrl. The value - can be used to disable all prefixing. (type: string, nullable)\n\tcaContent => null, // Content of the certificate for the CA, in base64 format, that signed your identity provider's web certificate. Defaults to the host's root CAs. (type: string, nullable)\n\tgroupsPrefix => null, // Prefix prepended to group claims to prevent clashes with existing names (such as system: groups). For example, the value oidc: will create group names like oidc:engineering and oidc:infra. (type: string, nullable)\n\tsigningAlgorithms => null, // The signing algorithms accepted. Default is \"RS256\". (type: array, nullable)\n\tusernameClaim => null, // JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins. (type: string, nullable)\n\tclientId => null, // Client ID (type: string)\n\tgroupsClaim => null, // JWT claim to use as the user's group. If the claim is present it must be an array of strings. (type: array, nullable)\n\tissuerUrl => null, // Issuer URL (type: string)\n\trequiredClaim => null, // key=value pairs that describe required claims in the ID Token. If set, the claims are verified to be present in the ID Token with a matching value. (type: array, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/openIdConnect/edit required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/privateNetworkConfiguration": get: summary: OVH Cloud Get private network configuration security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.PrivateNetworkConfiguration" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/kube/{kubeId}/privateNetworkConfiguration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/kube/{kubeId}/privateNetworkConfiguration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:kube/privateNetworkConfiguration/get required: true tags: - Cloud put: summary: OVH Cloud Update private network configuration security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.PrivateNetworkConfiguration" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.kube.ResponseMessage" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.kube.PrivateNetworkConfiguration\nresult = client.put(\"/cloud/project/{serviceName}/kube/{kubeId}/privateNetworkConfiguration\",\n\tdefaultVrackGateway = None, # If defined, all egress traffic will be routed towards this IP address, which should belong to the private network. Empty string means disabled. (type: string)\n\tprivateNetworkRoutingAsDefault = None, # Defines whether routing should default to using the nodes' private interface, instead of their public interface. Default is false. (type: boolean, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/kube/{kubeId}/privateNetworkConfiguration\", array(\n\tdefaultVrackGateway => null, // If defined, all egress traffic will be routed towards this IP address, which should belong to the private network. Empty string means disabled. (type: string)\n\tprivateNetworkRoutingAsDefault => null, // Defines whether routing should default to using the nodes' private interface, instead of their public interface. Default is false. (type: boolean, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/privateNetworkConfiguration/edit required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/reset": post: summary: 'OVH Cloud Reset cluster: all Kubernetes data will be erased (pods, services, configuration, etc), nodes will be either deleted or reinstalled' security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeResetCreation" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeResetCreation\nresult = client.post(\"/cloud/project/{serviceName}/kube/{kubeId}/reset\",\n\tprivateNetworkConfiguration = None, # The private network configuration. (type: )\n\tupdatePolicy = None, # Enum values for UpdatePolicy (type: )\n\tcustomization = None, # Kubernetes cluster customization (type: )\n\tloadBalancersSubnetId = None, # OpenStack subnet ID that the load balancers will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId and nodesSubnetId are also set (type: string)\n\tversion = None, # Kubernetes version to use after reset, by default it keeps the current version (type: )\n\tworkerNodesPolicy = None, # Worker nodes reset policy, default is delete (type: )\n\tname = None, # New cluster name (type: string)\n\tkubeProxyMode = None, # Selected mode for kube-proxy (type: )\n\tnodesSubnetId = None, # OpenStack subnet ID that the cluster nodes will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId is also set. If unspecified, it will be selected automatically when the first node is created. (type: string)\n\tprivateNetworkId = None, # OpenStack private network ID that the cluster will use. Optional, can only be set on cluster creation or reset. If unspecified, the cluster will use the public network. (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/kube/{kubeId}/reset\", array(\n\tname => null, // New cluster name (type: string)\n\tkubeProxyMode => null, // Selected mode for kube-proxy (type: )\n\tnodesSubnetId => null, // OpenStack subnet ID that the cluster nodes will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId is also set. If unspecified, it will be selected automatically when the first node is created. (type: string)\n\tupdatePolicy => null, // Enum values for UpdatePolicy (type: )\n\tcustomization => null, // Kubernetes cluster customization (type: )\n\tloadBalancersSubnetId => null, // OpenStack subnet ID that the load balancers will use. Optional, can only be set on cluster creation or reset, can only be set if privateNetworkId and nodesSubnetId are also set (type: string)\n\tversion => null, // Kubernetes version to use after reset, by default it keeps the current version (type: )\n\tworkerNodesPolicy => null, // Worker nodes reset policy, default is delete (type: )\n\tprivateNetworkId => null, // OpenStack private network ID that the cluster will use. Optional, can only be set on cluster creation or reset. If unspecified, the cluster will use the public network. (type: string)\n\tprivateNetworkConfiguration => null, // The private network configuration. (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/reset required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/restart": post: summary: OVH Cloud Restarting your control plane apiserver to invalidate cache without downtime (using force will create a slight downtime) security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeRestart" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeRestart\nresult = client.post(\"/cloud/project/{serviceName}/kube/{kubeId}/restart\",\n\tforce = None, # Force restarting control plane apiserver (will create a slight downtime) (type: boolean, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/kube/{kubeId}/restart\", array(\n\tforce => null, // Force restarting control plane apiserver (will create a slight downtime) (type: boolean, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/restart required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/update": post: summary: OVH Cloud Force cluster and node update to the latest patch within minor version or next minor version security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeUpdateCreation" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeUpdateCreation\nresult = client.post(\"/cloud/project/{serviceName}/kube/{kubeId}/update\",\n\tstrategy = None, # The update strategy to apply on your service (next patch or minor version) (type: )\n\tforce = None, # Force redeploying the control plane / reinstalling the nodes regardless of their current version (type: boolean, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/kube/{kubeId}/update\", array(\n\tforce => null, // Force redeploying the control plane / reinstalling the nodes regardless of their current version (type: boolean, nullable)\n\tstrategy => null, // The update strategy to apply on your service (next patch or minor version) (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/update required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/updateLoadBalancersSubnetId": put: summary: OVH Cloud Updates the load balancers subnet ID security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeUpdateLoadBalancersSubnetId" responses: '200': description: successful operation x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeUpdateLoadBalancersSubnetId\nresult = client.put(\"/cloud/project/{serviceName}/kube/{kubeId}/updateLoadBalancersSubnetId\",\n\tloadBalancersSubnetId = None, # OpenStack subnet ID that the load balancers will use (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/kube/{kubeId}/updateLoadBalancersSubnetId\", array(\n\tloadBalancersSubnetId => null, // OpenStack subnet ID that the load balancers will use (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/updateLoadBalancersSubnetId required: true tags: - Cloud "/cloud/project/{serviceName}/kube/{kubeId}/updatePolicy": put: summary: OVH Cloud Change the update policy of your cluster security: - oAuth2AuthCode: [] parameters: - in: path name: kubeId description: Kube ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectKubeUpdatePolicyUpdate" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectKubeUpdatePolicyUpdate\nresult = client.put(\"/cloud/project/{serviceName}/kube/{kubeId}/updatePolicy\",\n\tupdatePolicy = None, # Update policy (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/kube/{kubeId}/updatePolicy\", array(\n\tupdatePolicy => null, // Update policy (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:kube/updatePolicy required: true tags: - Cloud "/cloud/project/{serviceName}/lab": get: summary: OVH Cloud List available public cloud labs security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.Lab" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/lab\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/lab"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:lab/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/lab/{labId}": get: summary: OVH Cloud Get details of a public cloud lab security: - oAuth2AuthCode: [] parameters: - in: path name: labId description: Lab ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Lab" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/lab/{labId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/lab/{labId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:lab/get required: true x-response-identifier: id tags: - Cloud post: summary: OVH Cloud Activate a lab on your Cloud Project security: - oAuth2AuthCode: [] parameters: - in: path name: labId description: Lab ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/lab/{labId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/lab/{labId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:lab/create required: true tags: - Cloud "/cloud/project/{serviceName}/lab/{labId}/agreement": get: summary: OVH Cloud List required agreements to active this lab security: - oAuth2AuthCode: [] parameters: - in: path name: labId description: Lab ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.LabAgreements" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/lab/{labId}/agreement\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/lab/{labId}/agreement"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:lab/agreement/get required: true tags: - Cloud "/cloud/project/{serviceName}/loadbalancer": get: operationId: listLoadBalancers summary: OVH Cloud List all load balancer for a tenant security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string format: uuid '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::CouldNotAssignIPToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignIPToLoadBalancer message: Could not assign an ip address to the load balancer '{{.loadbalancer}}' Client::BadRequest::CouldNotAssignRegionToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignRegionToLoadBalancer message: Could not assign load balancer to the region '{{.location}}', the list of region available is located at '/cloud/project/{{.tenant}}/capabilities/loadbalancer/region' Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch: value: class: Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch message: Could not create load balancer '{{.loadbalancer}}' configuration, version mismatch, expected '{{.expected}}', but got '{{.got}}' Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration: value: class: Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration message: Could not delete the current load balancer '{{.loadbalancer}}' configuration '{{.version}}' '403': description: Error 403 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Forbidden::LoadBalancerIsFrozen: value: class: Client::Forbidden::LoadBalancerIsFrozen message: For legal purposes the load balancer '{{.loadbalancer}}' has been frozen Client::Forbidden::NotWhiteListed: value: class: Client::Forbidden::NotWhiteListed message: This project is not allowed to order load-balancer '500': description: Error 500 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration message: Could not apply load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotCreateLoadBalancer: value: class: Server::InternalServerError::CouldNotCreateLoadBalancer message: Could not create a load balancer Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration message: Could not create load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancer: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancer message: Could not delete the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration message: Could not delete load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotFindLoadBalancer: value: class: Server::InternalServerError::CouldNotFindLoadBalancer message: Could not find load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotFindLoadBalancerConfigurations: value: class: Server::InternalServerError::CouldNotFindLoadBalancerConfigurations message: Could not find load balancer '{{.loadbalancer}}' configurations Server::InternalServerError::CouldNotFindLoadBalancerIP: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIP message: Could not find the load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses message: Could not find load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration message: Could not find load balancers '{{.loadbalancer}}' last applied configuration Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration message: Could not find load balancers '{{.loadbalancer}}' latest configuration Server::InternalServerError::CouldNotFindRegion: value: class: Server::InternalServerError::CouldNotFindRegion message: Could not find region '{{.location}}' Server::InternalServerError::CouldNotListLoadBalancers: value: class: Server::InternalServerError::CouldNotListLoadBalancers message: Could not list load balancers Server::InternalServerError::CouldNotListRegions: value: class: Server::InternalServerError::CouldNotListRegions message: Could not list available regions Server::InternalServerError::CouldNotParseRequest: value: class: Server::InternalServerError::CouldNotParseRequest message: Could not parse the request Server::InternalServerError::CouldNotUpdateLoadBalancer: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancer message: Could not update the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration message: Could not update load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::MarshalingError: value: class: Server::InternalServerError::MarshalingError message: Could not serialize the response Server::InternalServerError::MissingParameterInRequestContext: value: class: Server::InternalServerError::MissingParameterInRequestContext message: Could not process the request x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/loadbalancer\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/loadbalancer"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:loadbalancer/get required: true x-expanded-response: CloudProjectLoadBalancer tags: - Cloud post: operationId: createLoadBalancer summary: OVH Cloud Create a load balancer security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.LoadBalancerCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.LoadBalancer" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::CouldNotAssignIPToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignIPToLoadBalancer message: Could not assign an ip address to the load balancer '{{.loadbalancer}}' Client::BadRequest::CouldNotAssignRegionToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignRegionToLoadBalancer message: Could not assign load balancer to the region '{{.location}}', the list of region available is located at '/cloud/project/{{.tenant}}/capabilities/loadbalancer/region' Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch: value: class: Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch message: Could not create load balancer '{{.loadbalancer}}' configuration, version mismatch, expected '{{.expected}}', but got '{{.got}}' Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration: value: class: Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration message: Could not delete the current load balancer '{{.loadbalancer}}' configuration '{{.version}}' '403': description: Error 403 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Forbidden::LoadBalancerIsFrozen: value: class: Client::Forbidden::LoadBalancerIsFrozen message: For legal purposes the load balancer '{{.loadbalancer}}' has been frozen Client::Forbidden::NotWhiteListed: value: class: Client::Forbidden::NotWhiteListed message: This project is not allowed to order load-balancer '500': description: Error 500 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration message: Could not apply load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotCreateLoadBalancer: value: class: Server::InternalServerError::CouldNotCreateLoadBalancer message: Could not create a load balancer Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration message: Could not create load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancer: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancer message: Could not delete the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration message: Could not delete load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotFindLoadBalancer: value: class: Server::InternalServerError::CouldNotFindLoadBalancer message: Could not find load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotFindLoadBalancerConfigurations: value: class: Server::InternalServerError::CouldNotFindLoadBalancerConfigurations message: Could not find load balancer '{{.loadbalancer}}' configurations Server::InternalServerError::CouldNotFindLoadBalancerIP: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIP message: Could not find the load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses message: Could not find load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration message: Could not find load balancers '{{.loadbalancer}}' last applied configuration Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration message: Could not find load balancers '{{.loadbalancer}}' latest configuration Server::InternalServerError::CouldNotFindRegion: value: class: Server::InternalServerError::CouldNotFindRegion message: Could not find region '{{.location}}' Server::InternalServerError::CouldNotListLoadBalancers: value: class: Server::InternalServerError::CouldNotListLoadBalancers message: Could not list load balancers Server::InternalServerError::CouldNotListRegions: value: class: Server::InternalServerError::CouldNotListRegions message: Could not list available regions Server::InternalServerError::CouldNotParseRequest: value: class: Server::InternalServerError::CouldNotParseRequest message: Could not parse the request Server::InternalServerError::CouldNotUpdateLoadBalancer: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancer message: Could not update the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration message: Could not update load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::MarshalingError: value: class: Server::InternalServerError::MarshalingError message: Could not serialize the response Server::InternalServerError::MissingParameterInRequestContext: value: class: Server::InternalServerError::MissingParameterInRequestContext message: Could not process the request x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.LoadBalancerCreation\nresult = client.post(\"/cloud/project/{serviceName}/loadbalancer\",\n\tnetworking = None, # Networking definition (type: cloud.project.loadbalancer.networking.NetworkingCreation, nullable)\n\topenstackRegion = None, # Openstack Region where the load balancer is hosted (type: string)\n\tregion = None, # Region where the load balancer is hosted (type: string)\n\tsize = None, # Size of the load balancer (type: cloud.project.loadbalancer.SizeEnum, nullable)\n\tdescription = None, # Description of the load balancer (type: string, nullable)\n\tname = None, # Name of the load balancer (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/loadbalancer\", array(\n\tname => null, // Name of the load balancer (type: string, nullable)\n\tnetworking => null, // Networking definition (type: cloud.project.loadbalancer.networking.NetworkingCreation, nullable)\n\topenstackRegion => null, // Openstack Region where the load balancer is hosted (type: string)\n\tregion => null, // Region where the load balancer is hosted (type: string)\n\tsize => null, // Size of the load balancer (type: cloud.project.loadbalancer.SizeEnum, nullable)\n\tdescription => null, // Description of the load balancer (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:loadbalancer/create required: true tags: - Cloud "/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}": delete: operationId: deleteLoadBalancer summary: OVH Cloud Delete a load balancer security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:loadbalancer/delete required: true tags: - Cloud get: operationId: getLoadBalancer summary: OVH Cloud Get a load balancer security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.LoadBalancer" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::CouldNotAssignIPToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignIPToLoadBalancer message: Could not assign an ip address to the load balancer '{{.loadbalancer}}' Client::BadRequest::CouldNotAssignRegionToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignRegionToLoadBalancer message: Could not assign load balancer to the region '{{.location}}', the list of region available is located at '/cloud/project/{{.tenant}}/capabilities/loadbalancer/region' Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch: value: class: Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch message: Could not create load balancer '{{.loadbalancer}}' configuration, version mismatch, expected '{{.expected}}', but got '{{.got}}' Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration: value: class: Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration message: Could not delete the current load balancer '{{.loadbalancer}}' configuration '{{.version}}' '403': description: Error 403 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Forbidden::LoadBalancerIsFrozen: value: class: Client::Forbidden::LoadBalancerIsFrozen message: For legal purposes the load balancer '{{.loadbalancer}}' has been frozen Client::Forbidden::NotWhiteListed: value: class: Client::Forbidden::NotWhiteListed message: This project is not allowed to order load-balancer '500': description: Error 500 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration message: Could not apply load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotCreateLoadBalancer: value: class: Server::InternalServerError::CouldNotCreateLoadBalancer message: Could not create a load balancer Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration message: Could not create load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancer: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancer message: Could not delete the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration message: Could not delete load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotFindLoadBalancer: value: class: Server::InternalServerError::CouldNotFindLoadBalancer message: Could not find load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotFindLoadBalancerConfigurations: value: class: Server::InternalServerError::CouldNotFindLoadBalancerConfigurations message: Could not find load balancer '{{.loadbalancer}}' configurations Server::InternalServerError::CouldNotFindLoadBalancerIP: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIP message: Could not find the load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses message: Could not find load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration message: Could not find load balancers '{{.loadbalancer}}' last applied configuration Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration message: Could not find load balancers '{{.loadbalancer}}' latest configuration Server::InternalServerError::CouldNotFindRegion: value: class: Server::InternalServerError::CouldNotFindRegion message: Could not find region '{{.location}}' Server::InternalServerError::CouldNotListLoadBalancers: value: class: Server::InternalServerError::CouldNotListLoadBalancers message: Could not list load balancers Server::InternalServerError::CouldNotListRegions: value: class: Server::InternalServerError::CouldNotListRegions message: Could not list available regions Server::InternalServerError::CouldNotParseRequest: value: class: Server::InternalServerError::CouldNotParseRequest message: Could not parse the request Server::InternalServerError::CouldNotUpdateLoadBalancer: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancer message: Could not update the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration message: Could not update load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::MarshalingError: value: class: Server::InternalServerError::MarshalingError message: Could not serialize the response Server::InternalServerError::MissingParameterInRequestContext: value: class: Server::InternalServerError::MissingParameterInRequestContext message: Could not process the request x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:loadbalancer/get required: true x-response-identifier: id tags: - Cloud put: operationId: updateLoadBalancer summary: OVH Cloud Update a load balancer security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.LoadBalancer" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.LoadBalancer" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::CouldNotAssignIPToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignIPToLoadBalancer message: Could not assign an ip address to the load balancer '{{.loadbalancer}}' Client::BadRequest::CouldNotAssignRegionToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignRegionToLoadBalancer message: Could not assign load balancer to the region '{{.location}}', the list of region available is located at '/cloud/project/{{.tenant}}/capabilities/loadbalancer/region' Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch: value: class: Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch message: Could not create load balancer '{{.loadbalancer}}' configuration, version mismatch, expected '{{.expected}}', but got '{{.got}}' Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration: value: class: Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration message: Could not delete the current load balancer '{{.loadbalancer}}' configuration '{{.version}}' '403': description: Error 403 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Forbidden::LoadBalancerIsFrozen: value: class: Client::Forbidden::LoadBalancerIsFrozen message: For legal purposes the load balancer '{{.loadbalancer}}' has been frozen Client::Forbidden::NotWhiteListed: value: class: Client::Forbidden::NotWhiteListed message: This project is not allowed to order load-balancer '500': description: Error 500 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration message: Could not apply load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotCreateLoadBalancer: value: class: Server::InternalServerError::CouldNotCreateLoadBalancer message: Could not create a load balancer Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration message: Could not create load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancer: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancer message: Could not delete the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration message: Could not delete load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotFindLoadBalancer: value: class: Server::InternalServerError::CouldNotFindLoadBalancer message: Could not find load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotFindLoadBalancerConfigurations: value: class: Server::InternalServerError::CouldNotFindLoadBalancerConfigurations message: Could not find load balancer '{{.loadbalancer}}' configurations Server::InternalServerError::CouldNotFindLoadBalancerIP: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIP message: Could not find the load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses message: Could not find load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration message: Could not find load balancers '{{.loadbalancer}}' last applied configuration Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration message: Could not find load balancers '{{.loadbalancer}}' latest configuration Server::InternalServerError::CouldNotFindRegion: value: class: Server::InternalServerError::CouldNotFindRegion message: Could not find region '{{.location}}' Server::InternalServerError::CouldNotListLoadBalancers: value: class: Server::InternalServerError::CouldNotListLoadBalancers message: Could not list load balancers Server::InternalServerError::CouldNotListRegions: value: class: Server::InternalServerError::CouldNotListRegions message: Could not list available regions Server::InternalServerError::CouldNotParseRequest: value: class: Server::InternalServerError::CouldNotParseRequest message: Could not parse the request Server::InternalServerError::CouldNotUpdateLoadBalancer: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancer message: Could not update the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration message: Could not update load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::MarshalingError: value: class: Server::InternalServerError::MarshalingError message: Could not serialize the response Server::InternalServerError::MissingParameterInRequestContext: value: class: Server::InternalServerError::MissingParameterInRequestContext message: Could not process the request x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.LoadBalancer\nresult = client.put(\"/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}\",\n\tname = None, # Name of the load balancer (type: string, nullable)\n\tsize = None, # Size of the load balancer (type: )\n\tdescription = None, # Description of the load balancer (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}\", array(\n\tname => null, // Name of the load balancer (type: string, nullable)\n\tsize => null, // Size of the load balancer (type: )\n\tdescription => null, // Description of the load balancer (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:loadbalancer/edit required: true tags: - Cloud "/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration": get: operationId: listLoadBalancerConfigurations summary: OVH Cloud List all versions of the configuration security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: integer '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::CouldNotAssignIPToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignIPToLoadBalancer message: Could not assign an ip address to the load balancer '{{.loadbalancer}}' Client::BadRequest::CouldNotAssignRegionToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignRegionToLoadBalancer message: Could not assign load balancer to the region '{{.location}}', the list of region available is located at '/cloud/project/{{.tenant}}/capabilities/loadbalancer/region' Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch: value: class: Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch message: Could not create load balancer '{{.loadbalancer}}' configuration, version mismatch, expected '{{.expected}}', but got '{{.got}}' Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration: value: class: Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration message: Could not delete the current load balancer '{{.loadbalancer}}' configuration '{{.version}}' '403': description: Error 403 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Forbidden::LoadBalancerIsFrozen: value: class: Client::Forbidden::LoadBalancerIsFrozen message: For legal purposes the load balancer '{{.loadbalancer}}' has been frozen Client::Forbidden::NotWhiteListed: value: class: Client::Forbidden::NotWhiteListed message: This project is not allowed to order load-balancer '500': description: Error 500 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration message: Could not apply load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotCreateLoadBalancer: value: class: Server::InternalServerError::CouldNotCreateLoadBalancer message: Could not create a load balancer Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration message: Could not create load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancer: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancer message: Could not delete the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration message: Could not delete load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotFindLoadBalancer: value: class: Server::InternalServerError::CouldNotFindLoadBalancer message: Could not find load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotFindLoadBalancerConfigurations: value: class: Server::InternalServerError::CouldNotFindLoadBalancerConfigurations message: Could not find load balancer '{{.loadbalancer}}' configurations Server::InternalServerError::CouldNotFindLoadBalancerIP: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIP message: Could not find the load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses message: Could not find load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration message: Could not find load balancers '{{.loadbalancer}}' last applied configuration Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration message: Could not find load balancers '{{.loadbalancer}}' latest configuration Server::InternalServerError::CouldNotFindRegion: value: class: Server::InternalServerError::CouldNotFindRegion message: Could not find region '{{.location}}' Server::InternalServerError::CouldNotListLoadBalancers: value: class: Server::InternalServerError::CouldNotListLoadBalancers message: Could not list load balancers Server::InternalServerError::CouldNotListRegions: value: class: Server::InternalServerError::CouldNotListRegions message: Could not list available regions Server::InternalServerError::CouldNotParseRequest: value: class: Server::InternalServerError::CouldNotParseRequest message: Could not parse the request Server::InternalServerError::CouldNotUpdateLoadBalancer: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancer message: Could not update the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration message: Could not update load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::MarshalingError: value: class: Server::InternalServerError::MarshalingError message: Could not serialize the response Server::InternalServerError::MissingParameterInRequestContext: value: class: Server::InternalServerError::MissingParameterInRequestContext message: Could not process the request x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:loadbalancer/configuration/get required: true x-expanded-response: CloudProjectLoadbalancerConfiguration tags: - Cloud post: operationId: createLoadBalancerConfiguration summary: OVH Cloud Create a configuration security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.project.loadbalancer.ConfigurationCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.loadbalancer.Configuration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::CouldNotAssignIPToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignIPToLoadBalancer message: Could not assign an ip address to the load balancer '{{.loadbalancer}}' Client::BadRequest::CouldNotAssignRegionToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignRegionToLoadBalancer message: Could not assign load balancer to the region '{{.location}}', the list of region available is located at '/cloud/project/{{.tenant}}/capabilities/loadbalancer/region' Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch: value: class: Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch message: Could not create load balancer '{{.loadbalancer}}' configuration, version mismatch, expected '{{.expected}}', but got '{{.got}}' Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration: value: class: Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration message: Could not delete the current load balancer '{{.loadbalancer}}' configuration '{{.version}}' '403': description: Error 403 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Forbidden::LoadBalancerIsFrozen: value: class: Client::Forbidden::LoadBalancerIsFrozen message: For legal purposes the load balancer '{{.loadbalancer}}' has been frozen Client::Forbidden::NotWhiteListed: value: class: Client::Forbidden::NotWhiteListed message: This project is not allowed to order load-balancer '500': description: Error 500 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration message: Could not apply load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotCreateLoadBalancer: value: class: Server::InternalServerError::CouldNotCreateLoadBalancer message: Could not create a load balancer Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration message: Could not create load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancer: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancer message: Could not delete the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration message: Could not delete load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotFindLoadBalancer: value: class: Server::InternalServerError::CouldNotFindLoadBalancer message: Could not find load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotFindLoadBalancerConfigurations: value: class: Server::InternalServerError::CouldNotFindLoadBalancerConfigurations message: Could not find load balancer '{{.loadbalancer}}' configurations Server::InternalServerError::CouldNotFindLoadBalancerIP: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIP message: Could not find the load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses message: Could not find load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration message: Could not find load balancers '{{.loadbalancer}}' last applied configuration Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration message: Could not find load balancers '{{.loadbalancer}}' latest configuration Server::InternalServerError::CouldNotFindRegion: value: class: Server::InternalServerError::CouldNotFindRegion message: Could not find region '{{.location}}' Server::InternalServerError::CouldNotListLoadBalancers: value: class: Server::InternalServerError::CouldNotListLoadBalancers message: Could not list load balancers Server::InternalServerError::CouldNotListRegions: value: class: Server::InternalServerError::CouldNotListRegions message: Could not list available regions Server::InternalServerError::CouldNotParseRequest: value: class: Server::InternalServerError::CouldNotParseRequest message: Could not parse the request Server::InternalServerError::CouldNotUpdateLoadBalancer: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancer message: Could not update the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration message: Could not update load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::MarshalingError: value: class: Server::InternalServerError::MarshalingError message: Could not serialize the response Server::InternalServerError::MissingParameterInRequestContext: value: class: Server::InternalServerError::MissingParameterInRequestContext message: Could not process the request x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.project.loadbalancer.ConfigurationCreation\nresult = client.post(\"/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration\",\n\tbackends = None, # List of backends (type: array)\n\tcertificates = None, # List of certificate ID (type: array)\n\tfrontends = None, # List of frontends (type: array)\n\tnetworking = None, # networking configuration (type: cloud.project.loadbalancer.configuration.networking.Networking, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration\", array(\n\tbackends => null, // List of backends (type: array)\n\tcertificates => null, // List of certificate ID (type: array)\n\tfrontends => null, // List of frontends (type: array)\n\tnetworking => null, // networking configuration (type: cloud.project.loadbalancer.configuration.networking.Networking, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:loadbalancer/configuration/create required: true tags: - Cloud "/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration/{version}": delete: operationId: deleteLoadBalancerConfiguration summary: OVH Cloud Delete a configuration security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: version description: Version required: true schema: type: integer responses: '200': description: successful operation x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration/{version}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration/{version}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:loadbalancer/configuration/delete required: true tags: - Cloud get: operationId: getLoadBalancerConfiguration summary: OVH Cloud Get a configuration security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: version description: Version required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.loadbalancer.Configuration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::CouldNotAssignIPToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignIPToLoadBalancer message: Could not assign an ip address to the load balancer '{{.loadbalancer}}' Client::BadRequest::CouldNotAssignRegionToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignRegionToLoadBalancer message: Could not assign load balancer to the region '{{.location}}', the list of region available is located at '/cloud/project/{{.tenant}}/capabilities/loadbalancer/region' Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch: value: class: Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch message: Could not create load balancer '{{.loadbalancer}}' configuration, version mismatch, expected '{{.expected}}', but got '{{.got}}' Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration: value: class: Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration message: Could not delete the current load balancer '{{.loadbalancer}}' configuration '{{.version}}' '403': description: Error 403 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Forbidden::LoadBalancerIsFrozen: value: class: Client::Forbidden::LoadBalancerIsFrozen message: For legal purposes the load balancer '{{.loadbalancer}}' has been frozen Client::Forbidden::NotWhiteListed: value: class: Client::Forbidden::NotWhiteListed message: This project is not allowed to order load-balancer '500': description: Error 500 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration message: Could not apply load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotCreateLoadBalancer: value: class: Server::InternalServerError::CouldNotCreateLoadBalancer message: Could not create a load balancer Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration message: Could not create load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancer: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancer message: Could not delete the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration message: Could not delete load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotFindLoadBalancer: value: class: Server::InternalServerError::CouldNotFindLoadBalancer message: Could not find load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotFindLoadBalancerConfigurations: value: class: Server::InternalServerError::CouldNotFindLoadBalancerConfigurations message: Could not find load balancer '{{.loadbalancer}}' configurations Server::InternalServerError::CouldNotFindLoadBalancerIP: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIP message: Could not find the load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses message: Could not find load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration message: Could not find load balancers '{{.loadbalancer}}' last applied configuration Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration message: Could not find load balancers '{{.loadbalancer}}' latest configuration Server::InternalServerError::CouldNotFindRegion: value: class: Server::InternalServerError::CouldNotFindRegion message: Could not find region '{{.location}}' Server::InternalServerError::CouldNotListLoadBalancers: value: class: Server::InternalServerError::CouldNotListLoadBalancers message: Could not list load balancers Server::InternalServerError::CouldNotListRegions: value: class: Server::InternalServerError::CouldNotListRegions message: Could not list available regions Server::InternalServerError::CouldNotParseRequest: value: class: Server::InternalServerError::CouldNotParseRequest message: Could not parse the request Server::InternalServerError::CouldNotUpdateLoadBalancer: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancer message: Could not update the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration message: Could not update load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::MarshalingError: value: class: Server::InternalServerError::MarshalingError message: Could not serialize the response Server::InternalServerError::MissingParameterInRequestContext: value: class: Server::InternalServerError::MissingParameterInRequestContext message: Could not process the request x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration/{version}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration/{version}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:loadbalancer/configuration/get required: true x-response-identifier: version tags: - Cloud "/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration/{version}/apply": post: operationId: applyLoadBalancerConfiguration summary: OVH Cloud Apply a configuration security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: version description: Version required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.loadbalancer.Configuration" '400': description: Error 400 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::BadRequest::CouldNotAssignIPToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignIPToLoadBalancer message: Could not assign an ip address to the load balancer '{{.loadbalancer}}' Client::BadRequest::CouldNotAssignRegionToLoadBalancer: value: class: Client::BadRequest::CouldNotAssignRegionToLoadBalancer message: Could not assign load balancer to the region '{{.location}}', the list of region available is located at '/cloud/project/{{.tenant}}/capabilities/loadbalancer/region' Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch: value: class: Client::BadRequest::CouldNotCreateLoadBalancerConfigurationVersionMismatch message: Could not create load balancer '{{.loadbalancer}}' configuration, version mismatch, expected '{{.expected}}', but got '{{.got}}' Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration: value: class: Client::BadRequest::CouldNotCurrentDeleteLoadBalancerConfiguration message: Could not delete the current load balancer '{{.loadbalancer}}' configuration '{{.version}}' '403': description: Error 403 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Client::Forbidden::LoadBalancerIsFrozen: value: class: Client::Forbidden::LoadBalancerIsFrozen message: For legal purposes the load balancer '{{.loadbalancer}}' has been frozen Client::Forbidden::NotWhiteListed: value: class: Client::Forbidden::NotWhiteListed message: This project is not allowed to order load-balancer '500': description: Error 500 response content: application/json: schema: type: object description: Common error model properties: class: type: string description: Class of the error message: type: string description: Error message examples: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotApplyLoadBalancerConfiguration message: Could not apply load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotCreateLoadBalancer: value: class: Server::InternalServerError::CouldNotCreateLoadBalancer message: Could not create a load balancer Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotCreateLoadBalancerConfiguration message: Could not create load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancer: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancer message: Could not delete the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotDeleteLoadBalancerConfiguration message: Could not delete load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::CouldNotFindLoadBalancer: value: class: Server::InternalServerError::CouldNotFindLoadBalancer message: Could not find load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotFindLoadBalancerConfigurations: value: class: Server::InternalServerError::CouldNotFindLoadBalancerConfigurations message: Could not find load balancer '{{.loadbalancer}}' configurations Server::InternalServerError::CouldNotFindLoadBalancerIP: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIP message: Could not find the load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses: value: class: Server::InternalServerError::CouldNotFindLoadBalancerIPAddresses message: Could not find load balancer '{{.loadbalancer}}' ip's address Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLastAppliedConfiguration message: Could not find load balancers '{{.loadbalancer}}' last applied configuration Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration: value: class: Server::InternalServerError::CouldNotFindLoadBalancerLatestConfiguration message: Could not find load balancers '{{.loadbalancer}}' latest configuration Server::InternalServerError::CouldNotFindRegion: value: class: Server::InternalServerError::CouldNotFindRegion message: Could not find region '{{.location}}' Server::InternalServerError::CouldNotListLoadBalancers: value: class: Server::InternalServerError::CouldNotListLoadBalancers message: Could not list load balancers Server::InternalServerError::CouldNotListRegions: value: class: Server::InternalServerError::CouldNotListRegions message: Could not list available regions Server::InternalServerError::CouldNotParseRequest: value: class: Server::InternalServerError::CouldNotParseRequest message: Could not parse the request Server::InternalServerError::CouldNotUpdateLoadBalancer: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancer message: Could not update the load balancer '{{.loadbalancer}}' Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration: value: class: Server::InternalServerError::CouldNotUpdateLoadBalancerConfiguration message: Could not update load balancer '{{.loadbalancer}}' configuration '{{.version}}' Server::InternalServerError::MarshalingError: value: class: Server::InternalServerError::MarshalingError message: Could not serialize the response Server::InternalServerError::MissingParameterInRequestContext: value: class: Server::InternalServerError::MissingParameterInRequestContext message: Could not process the request x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration/{version}/apply\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/loadbalancer/{loadBalancerId}/configuration/{version}/apply"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:loadbalancer/configuration/apply required: true tags: - Cloud "/cloud/project/{serviceName}/network/private": get: summary: OVH Cloud Get private networks security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.network.Network" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/network/private\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/network/private"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:network/private/get required: true x-response-identifier: id x-expanded-response: CloudNetworkNetwork tags: - Cloud post: summary: OVH Cloud Create a new network security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectNetworkPrivateCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.network.Network" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectNetworkPrivateCreation\nresult = client.post(\"/cloud/project/{serviceName}/network/private\",\n\tname = None, # Network name (type: string)\n\tregions = None, # Region where to activate private network. No parameters means all region (type: array, nullable)\n\tvlanId = None, # Vland id, between 0 and 4000. 0 value means no vlan. (type: integer, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/network/private\", array(\n\tregions => null, // Region where to activate private network. No parameters means all region (type: array, nullable)\n\tvlanId => null, // Vland id, between 0 and 4000. 0 value means no vlan. (type: integer, nullable)\n\tname => null, // Network name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:network/private/create required: true tags: - Cloud "/cloud/project/{serviceName}/network/private/{networkId}": delete: summary: OVH Cloud Delete private network security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/network/private/{networkId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/network/private/{networkId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:network/private/delete required: true tags: - Cloud get: summary: OVH Cloud Get private network security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.network.Network" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/network/private/{networkId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/network/private/{networkId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:network/private/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Rename private network security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectNetworkPrivateUpdate" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectNetworkPrivateUpdate\nresult = client.put(\"/cloud/project/{serviceName}/network/private/{networkId}\",\n\tname = None, # name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/network/private/{networkId}\", array(\n\tname => null, // name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:network/private/edit required: true tags: - Cloud "/cloud/project/{serviceName}/network/private/{networkId}/region": post: summary: OVH Cloud Activate private network in a new region security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectNetworkPrivateRegionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.network.Network" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectNetworkPrivateRegionCreation\nresult = client.post(\"/cloud/project/{serviceName}/network/private/{networkId}/region\",\n\tregion = None, # Region to active on your network (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/network/private/{networkId}/region\", array(\n\tregion => null, // Region to active on your network (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:network/private/region/create required: true tags: - Cloud "/cloud/project/{serviceName}/network/private/{networkId}/subnet": get: summary: OVH Cloud Get network subnets security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.network.Subnet" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/network/private/{networkId}/subnet\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/network/private/{networkId}/subnet"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:network/private/subnet/get required: true x-response-identifier: id x-expanded-response: CloudNetworkSubnet tags: - Cloud post: summary: OVH Cloud Create a new network subnet security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectNetworkPrivateSubnetCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.network.Subnet" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectNetworkPrivateSubnetCreation\nresult = client.post(\"/cloud/project/{serviceName}/network/private/{networkId}/subnet\",\n\tnetwork = None, # Global network with cidr (eg: 192.168.1.0/24) (type: )\n\tnoGateway = None, # Set to true if you don't want to set a default gateway IP (type: boolean)\n\tregion = None, # Region where this subnet will be created (type: string)\n\tstart = None, # First IP for this region (eg: 192.168.1.12) (type: )\n\tdhcp = None, # Enable DHCP (type: boolean)\n\tend = None, # Last IP for this region (eg: 192.168.1.24) (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/network/private/{networkId}/subnet\", array(\n\tend => null, // Last IP for this region (eg: 192.168.1.24) (type: )\n\tnetwork => null, // Global network with cidr (eg: 192.168.1.0/24) (type: )\n\tnoGateway => null, // Set to true if you don't want to set a default gateway IP (type: boolean)\n\tregion => null, // Region where this subnet will be created (type: string)\n\tstart => null, // First IP for this region (eg: 192.168.1.12) (type: )\n\tdhcp => null, // Enable DHCP (type: boolean)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:network/private/subnet/create required: true tags: - Cloud "/cloud/project/{serviceName}/network/private/{networkId}/subnet/{subnetId}": delete: summary: OVH Cloud Delete a network subnet security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: subnetId description: Subnet ID required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/network/private/{networkId}/subnet/{subnetId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/network/private/{networkId}/subnet/{subnetId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:network/private/subnet/delete required: true tags: - Cloud "/cloud/project/{serviceName}/network/public": get: summary: OVH Cloud Get public networks security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.network.Network" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/network/public\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/network/public"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:network/public/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/operation": get: summary: OVH Cloud List your operations security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/operation\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/operation"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:operation/get required: true x-response-identifier: id x-expanded-response: CloudOperation tags: - Cloud "/cloud/project/{serviceName}/operation/{operationId}": get: summary: OVH Cloud Get information about one operation security: - oAuth2AuthCode: [] parameters: - in: path name: operationId description: Operation ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/operation/{operationId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/operation/{operationId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:operation/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/quota": get: summary: OVH Cloud List quotas security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.quota.Quotas" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/quota\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/quota"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:quota/get required: true tags: - Cloud "/cloud/project/{serviceName}/region": get: summary: OVH Cloud List your regions security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: type: string x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/get required: true x-expanded-response: CloudRegion tags: - Cloud post: summary: OVH Cloud Request access to a region security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectRegionCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Region" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectRegionCreation\nresult = client.post(\"/cloud/project/{serviceName}/region\",\n\tregion = None, # Region to add on your project (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region\", array(\n\tregion => null, // Region to add on your project (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}": get: summary: OVH Cloud Get information about your region security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Region" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/floatingip": get: summary: OVH Cloud Get floating ips security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.FloatingIp" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/floatingip\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/floatingip"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/floatingip/get required: true x-response-identifier: id x-expanded-response: CloudProjectFloatingIp tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/floatingip/{floatingIpId}": delete: summary: OVH Cloud Delete a floating ip security: - oAuth2AuthCode: [] parameters: - in: path name: floatingIpId description: Floating ip ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/floatingip/{floatingIpId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/floatingip/{floatingIpId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/floatingip/delete required: true tags: - Cloud get: summary: OVH Cloud Get a floating ip security: - oAuth2AuthCode: [] parameters: - in: path name: floatingIpId description: Floating ip ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.FloatingIp" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/floatingip/{floatingIpId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/floatingip/{floatingIpId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/floatingip/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/floatingip/{floatingIpId}/detach": post: summary: OVH Cloud Detach your floating ip security: - oAuth2AuthCode: [] parameters: - in: path name: floatingIpId description: Floating ip ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/floatingip/{floatingIpId}/detach\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/region/{regionName}/floatingip/{floatingIpId}/detach"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/floatingip/detach required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/gateway": get: summary: OVH Cloud List gateways security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: query name: subnetId description: Attached interface's subnet id schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.network.Gateway" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/gateway\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/gateway"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/gateway/get required: true x-response-identifier: id x-expanded-response: CloudNetworkGateway tags: - Cloud post: summary: OVH Cloud Create new Gateway and new Private Network with new Subnet security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.network.CreateGateway" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.network.CreateGateway\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/gateway\",\n\tmodel = None, # Model of the gateway (type: )\n\tname = None, # Name of the gateway (type: string)\n\tnetwork = None, # Information to create the network for the gateway (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/gateway\", array(\n\tmodel => null, // Model of the gateway (type: )\n\tname => null, // Name of the gateway (type: string)\n\tnetwork => null, // Information to create the network for the gateway (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/gateway/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/gateway/{id}": delete: summary: OVH Cloud Delete gateway security: - oAuth2AuthCode: [] parameters: - in: path name: id description: Id required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/gateway/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/gateway/{id}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/gateway/delete required: true tags: - Cloud get: summary: OVH Cloud Get gateway security: - oAuth2AuthCode: [] parameters: - in: path name: id description: Id required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.network.Gateway" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/gateway/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/gateway/{id}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/gateway/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update a gateway security: - oAuth2AuthCode: [] parameters: - in: path name: id description: Id required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.network.UpdateGateway" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.network.Gateway" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.network.UpdateGateway\nresult = client.put(\"/cloud/project/{serviceName}/region/{regionName}/gateway/{id}\",\n\tmodel = None, # Model of the gateway (type: )\n\tname = None, # Name of the gateway (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/region/{regionName}/gateway/{id}\", array(\n\tmodel => null, // Model of the gateway (type: )\n\tname => null, // Name of the gateway (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/gateway/edit required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/expose": post: summary: OVH Cloud Expose gateway to public network by adding a public port on it. security: - oAuth2AuthCode: [] parameters: - in: path name: id description: Id required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.network.Gateway" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/expose\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/expose"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/gateway/expose required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface": get: summary: OVH Cloud List interfaces security: - oAuth2AuthCode: [] parameters: - in: path name: id description: Id required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.network.gateway.Interface" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/gateway/interface/get required: true x-response-identifier: id x-expanded-response: CloudNetworkGatewayInterface tags: - Cloud post: summary: OVH Cloud Create gateway interface security: - oAuth2AuthCode: [] parameters: - in: path name: id description: Id required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.network.gateway.CreateInterface" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.network.gateway.Interface" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.network.gateway.CreateInterface\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface\",\n\tsubnetId = None, # Subnet id to add (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface\", array(\n\tsubnetId => null, // Subnet id to add (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/gateway/interface/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface/{interfaceId}": delete: summary: OVH Cloud Delete gateway interface security: - oAuth2AuthCode: [] parameters: - in: path name: id description: Id required: true schema: type: string format: uuid - in: path name: interfaceId description: Interface ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface/{interfaceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface/{interfaceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/gateway/interface/delete required: true tags: - Cloud get: summary: OVH Cloud Get interface security: - oAuth2AuthCode: [] parameters: - in: path name: id description: Id required: true schema: type: string format: uuid - in: path name: interfaceId description: Interface ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.network.gateway.Interface" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface/{interfaceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/gateway/{id}/interface/{interfaceId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/gateway/interface/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/abortSnapshot": post: summary: OVH Cloud Abort an instance snapshot creation security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/abortSnapshot\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/abortSnapshot"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/instance/abortSnapshot required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/associateFloatingIp": post: summary: OVH Cloud Associate an existing floating IP to an instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.AssociateFloatingIp" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.instance.AssociateFloatingIp\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/associateFloatingIp\",\n\tfloatingIpId = None, # Floating IP ID (type: string)\n\tgateway = None, # Parameters to create a gateway if required (type: cloud.network.CreateGatewaySummary, nullable)\n\tip = None, # Private instance IP to associate the floating IP with (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/associateFloatingIp\", array(\n\tfloatingIpId => null, // Floating IP ID (type: string)\n\tgateway => null, // Parameters to create a gateway if required (type: cloud.network.CreateGatewaySummary, nullable)\n\tip => null, // Private instance IP to associate the floating IP with (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/instance/associateFloatingIp required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/floatingIp": post: summary: OVH Cloud Create a floating IP and attach it to an instance security: - oAuth2AuthCode: [] parameters: - in: path name: instanceId description: Instance ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.instance.CreateFloatingIp" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.instance.CreateFloatingIp\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/floatingIp\",\n\tgateway = None, # Parameters to create a gateway if required (type: cloud.network.CreateGatewaySummary, nullable)\n\tip = None, # Private instance IP to associate the floating IP with (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/instance/{instanceId}/floatingIp\", array(\n\tgateway => null, // Parameters to create a gateway if required (type: cloud.network.CreateGatewaySummary, nullable)\n\tip => null, // Private instance IP to associate the floating IP with (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/instance/floatingIp/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/keymanager/certificate": get: summary: OVH Cloud List certificates security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.keymanager.Certificate" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/keymanager/certificate\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/keymanager/certificate"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/keymanager/certificate/get required: true x-response-identifier: id x-expanded-response: CloudKeymanagerCertificate tags: - Cloud post: summary: OVH Cloud Create a new certificate security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.keymanager.CertificateCreate" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.keymanager.Certificate" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.keymanager.CertificateCreate\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/keymanager/certificate\",\n\tname = None, # Name of the certificate (type: string)\n\tprivateKey = None, # Private key (type: string)\n\tprivateKeyPassphrase = None, # Private key passphrase if any (type: string)\n\tcertificate = None, # Content of the certificate (type: string)\n\tintermediates = None, # Content of the intermediates certificates if any (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/keymanager/certificate\", array(\n\tcertificate => null, // Content of the certificate (type: string)\n\tintermediates => null, // Content of the intermediates certificates if any (type: string)\n\tname => null, // Name of the certificate (type: string)\n\tprivateKey => null, // Private key (type: string)\n\tprivateKeyPassphrase => null, // Private key passphrase if any (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/keymanager/certificate/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/keymanager/certificate/{certificateId}": delete: summary: OVH Cloud Delete a certificate security: - oAuth2AuthCode: [] parameters: - in: path name: certificateId description: Certificate ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/keymanager/certificate/{certificateId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/keymanager/certificate/{certificateId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/keymanager/certificate/delete required: true tags: - Cloud get: summary: OVH Cloud Get details about a certificate security: - oAuth2AuthCode: [] parameters: - in: path name: certificateId description: Certificate ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.keymanager.Certificate" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/keymanager/certificate/{certificateId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/keymanager/certificate/{certificateId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/keymanager/certificate/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/keymanager/secret": get: summary: OVH Cloud List secrets security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.keymanager.Secret" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/keymanager/secret\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/keymanager/secret"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/keymanager/secret/get required: true x-response-identifier: id x-expanded-response: CloudKeymanagerSecret tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/keymanager/secret/{secretId}": delete: summary: OVH Cloud Delete a secret security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: secretId description: Secret ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/keymanager/secret/{secretId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/keymanager/secret/{secretId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/keymanager/secret/delete required: true tags: - Cloud get: summary: OVH Cloud Get details about a secret security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: secretId description: Secret ID required: true schema: type: string format: uuid - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.keymanager.Secret" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/keymanager/secret/{secretId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/keymanager/secret/{secretId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/keymanager/secret/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/flavor": get: summary: OVH Cloud List flavors security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.loadbalancing.Flavor" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/flavor\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/flavor"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/flavor/get required: true x-response-identifier: id x-expanded-response: CloudLoadbalancingFlavor tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/flavor/{flavorId}": get: summary: OVH Cloud Get details about a load balancing flavor security: - oAuth2AuthCode: [] parameters: - in: path name: flavorId description: Flavor ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.Flavor" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/flavor/{flavorId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/flavor/{flavorId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/flavor/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor": get: summary: OVH Cloud List health monitors security: - oAuth2AuthCode: [] parameters: - in: query name: poolId description: Linked pool id schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.loadbalancing.HealthMonitor" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/healthMonitor/get required: true x-response-identifier: id x-expanded-response: CloudLoadbalancingHealthMonitor tags: - Cloud post: summary: OVH Cloud Create health monitor security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.HealthMonitor" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.HealthMonitor" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.HealthMonitor\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor\",\n\tmaxRetries = None, # Number of successful checks before changing the operating status of the member to ONLINE (type: integer)\n\ttimeout = None, # Maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value (type: integer)\n\tmaxRetriesDown = None, # Number of allowed check failures before changing the operating status of the member to ERROR (type: integer, nullable)\n\tmonitorType = None, # Type of the monitor (type: )\n\tname = None, # The name of the resource (type: string)\n\tpoolId = None, # The ID of the pool (type: string)\n\thttpConfiguration = None, # Monitor HTTP configuration (type: cloud.loadbalancing.HealthMonitorHTTPConfiguration, nullable)\n\tdelay = None, # Duration between sending probes to members, in seconds (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor\", array(\n\tdelay => null, // Duration between sending probes to members, in seconds (type: integer)\n\tname => null, // The name of the resource (type: string)\n\tpoolId => null, // The ID of the pool (type: string)\n\thttpConfiguration => null, // Monitor HTTP configuration (type: cloud.loadbalancing.HealthMonitorHTTPConfiguration, nullable)\n\tmaxRetries => null, // Number of successful checks before changing the operating status of the member to ONLINE (type: integer)\n\ttimeout => null, // Maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value (type: integer)\n\tmaxRetriesDown => null, // Number of allowed check failures before changing the operating status of the member to ERROR (type: integer, nullable)\n\tmonitorType => null, // Type of the monitor (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/healthMonitor/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor/{healthMonitorId}": delete: summary: OVH Cloud Delete health monitor security: - oAuth2AuthCode: [] parameters: - in: path name: healthMonitorId description: Health monitor ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor/{healthMonitorId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor/{healthMonitorId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/healthMonitor/delete required: true tags: - Cloud get: summary: OVH Cloud Get details about a loadbalancer health monitor security: - oAuth2AuthCode: [] parameters: - in: path name: healthMonitorId description: Health monitor ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.HealthMonitor" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor/{healthMonitorId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor/{healthMonitorId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/healthMonitor/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update a health monitor security: - oAuth2AuthCode: [] parameters: - in: path name: healthMonitorId description: Health monitor ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.UpdateHealthMonitor" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.HealthMonitor" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.UpdateHealthMonitor\nresult = client.put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor/{healthMonitorId}\",\n\tname = None, # The name of the resource (type: string)\n\ttimeout = None, # Maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value (type: integer)\n\tdelay = None, # Duration between sending probes to members, in seconds (type: integer)\n\thttpConfiguration = None, # Monitor HTTP configuration (type: )\n\tmaxRetries = None, # Number of successful checks before changing the operating status of the member to ONLINE (type: integer)\n\tmaxRetriesDown = None, # Number of allowed check failures before changing the operating status of the member to ERROR (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/healthMonitor/{healthMonitorId}\", array(\n\tmaxRetriesDown => null, // Number of allowed check failures before changing the operating status of the member to ERROR (type: integer)\n\tname => null, // The name of the resource (type: string)\n\ttimeout => null, // Maximum time, in seconds, that a monitor waits to connect before it times out. This value must be less than the delay value (type: integer)\n\tdelay => null, // Duration between sending probes to members, in seconds (type: integer)\n\thttpConfiguration => null, // Monitor HTTP configuration (type: )\n\tmaxRetries => null, // Number of successful checks before changing the operating status of the member to ONLINE (type: integer)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/healthMonitor/edit required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy": get: security: - oAuth2AuthCode: [] parameters: - in: query name: listenerId description: Linked listener id schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.loadbalancing.L7Policy" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/l7Policy/get required: true x-response-identifier: id x-expanded-response: CloudLoadbalancingL7Policy tags: - Cloud post: security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.L7Policy" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.L7Policy" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.L7Policy\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy\",\n\tredirectHttpCode = None, # Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if action is \"redirect_to\" or \"redirect_prefix\" (type: cloud.loadbalancing.L7PolicyRedirectHTTPCodeEnum, nullable)\n\tredirectUrl = None, # Requests matching this policy will be redirected to this URL. Only valid if action is \"redirect_to_url\" (type: string, nullable)\n\tdescription = None, # A human-readable description for the resource (type: string)\n\tname = None, # Human-readable name of the resource (type: string)\n\taction = None, # The L7 policy action (type: )\n\tposition = None, # The position of this policy on the listener. Positions start at 1 (type: integer)\n\tredirectPrefix = None, # Requests matching this policy will be redirected to this Prefix URL. Only valid if action is \"redirect_prefix\" (type: string, nullable)\n\tredirectPoolId = None, # Requests matching this policy will be redirected to the pool with this ID. Only valid if action is \"redirect_to_pool\" (type: string, nullable)\n\tlistenerId = None, # The ID of the listener. (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy\", array(\n\tname => null, // Human-readable name of the resource (type: string)\n\taction => null, // The L7 policy action (type: )\n\tposition => null, // The position of this policy on the listener. Positions start at 1 (type: integer)\n\tredirectPrefix => null, // Requests matching this policy will be redirected to this Prefix URL. Only valid if action is \"redirect_prefix\" (type: string, nullable)\n\tredirectPoolId => null, // Requests matching this policy will be redirected to the pool with this ID. Only valid if action is \"redirect_to_pool\" (type: string, nullable)\n\tlistenerId => null, // The ID of the listener. (type: string)\n\tdescription => null, // A human-readable description for the resource (type: string)\n\tredirectUrl => null, // Requests matching this policy will be redirected to this URL. Only valid if action is \"redirect_to_url\" (type: string, nullable)\n\tredirectHttpCode => null, // Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if action is \"redirect_to\" or \"redirect_prefix\" (type: cloud.loadbalancing.L7PolicyRedirectHTTPCodeEnum, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/l7Policy/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}": delete: security: - oAuth2AuthCode: [] parameters: - in: path name: l7PolicyId description: L7 policy ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/l7Policy/delete required: true tags: - Cloud get: security: - oAuth2AuthCode: [] parameters: - in: path name: l7PolicyId description: L7 policy ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.L7Policy" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/l7Policy/get required: true x-response-identifier: id tags: - Cloud put: security: - oAuth2AuthCode: [] parameters: - in: path name: l7PolicyId description: L7 policy ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.L7PolicyUpdate" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.L7Policy" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.L7PolicyUpdate\nresult = client.put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}\",\n\tname = None, # Human-readable name of the resource (type: string)\n\tredirectHttpCode = None, # Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if action is \"redirect_to\" or \"redirect_prefix\" (type: integer, nullable)\n\tredirectPoolId = None, # Requests matching this policy will be redirected to the pool with this ID. Only valid if action is \"redirect_to_pool\" (type: string, nullable)\n\tredirectUrl = None, # Requests matching this policy will be redirected to this URL. Only valid if action is \"redirect_to_url\" (type: string, nullable)\n\tlistenerId = None, # The ID of the listener. (type: string)\n\taction = None, # The L7 policy action (type: )\n\tdescription = None, # A human-readable description for the resource (type: string)\n\tposition = None, # The position of this policy on the listener. Positions start at 1 (type: integer)\n\tredirectPrefix = None, # Requests matching this policy will be redirected to this Prefix URL. Only valid if action is \"redirect_prefix\" (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}\", array(\n\tposition => null, // The position of this policy on the listener. Positions start at 1 (type: integer)\n\tredirectPrefix => null, // Requests matching this policy will be redirected to this Prefix URL. Only valid if action is \"redirect_prefix\" (type: string, nullable)\n\tdescription => null, // A human-readable description for the resource (type: string)\n\tredirectUrl => null, // Requests matching this policy will be redirected to this URL. Only valid if action is \"redirect_to_url\" (type: string, nullable)\n\tlistenerId => null, // The ID of the listener. (type: string)\n\taction => null, // The L7 policy action (type: )\n\tname => null, // Human-readable name of the resource (type: string)\n\tredirectHttpCode => null, // Requests matching this policy will be redirected to the specified URL or Prefix URL with the HTTP response code. Valid if action is \"redirect_to\" or \"redirect_prefix\" (type: integer, nullable)\n\tredirectPoolId => null, // Requests matching this policy will be redirected to the pool with this ID. Only valid if action is \"redirect_to_pool\" (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/l7Policy/edit required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule": get: security: - oAuth2AuthCode: [] parameters: - in: path name: l7PolicyId description: L7 policy ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.loadbalancing.L7Rule" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/l7Policy/l7Rule/get required: true x-response-identifier: id x-expanded-response: CloudLoadbalancingL7Rule tags: - Cloud post: security: - oAuth2AuthCode: [] parameters: - in: path name: l7PolicyId description: L7 policy ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.L7Rule" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.L7Rule" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.L7Rule\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule\",\n\truleType = None, # The L7 rule type (type: )\n\tvalue = None, # The value to use for the comparison. For example, the file type to compare (type: string)\n\tcompareType = None, # The comparison type for the L7 rule (type: )\n\tinvert = None, # When true the logic of the rule is inverted. For example, with invert set to true, equal to would become not equal to (type: boolean)\n\tkey = None, # The key to use for the comparison. For example, the name of the cookie to evaluate (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule\", array(\n\tcompareType => null, // The comparison type for the L7 rule (type: )\n\tinvert => null, // When true the logic of the rule is inverted. For example, with invert set to true, equal to would become not equal to (type: boolean)\n\tkey => null, // The key to use for the comparison. For example, the name of the cookie to evaluate (type: string)\n\truleType => null, // The L7 rule type (type: )\n\tvalue => null, // The value to use for the comparison. For example, the file type to compare (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/l7Policy/l7Rule/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId}": delete: security: - oAuth2AuthCode: [] parameters: - in: path name: l7PolicyId description: L7 policy ID required: true schema: type: string format: uuid - in: path name: l7RuleId description: L7 rule ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/l7Policy/l7Rule/delete required: true tags: - Cloud get: security: - oAuth2AuthCode: [] parameters: - in: path name: l7PolicyId description: L7 policy ID required: true schema: type: string format: uuid - in: path name: l7RuleId description: L7 rule ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.L7Rule" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/l7Policy/l7Rule/get required: true x-response-identifier: id tags: - Cloud put: security: - oAuth2AuthCode: [] parameters: - in: path name: l7PolicyId description: L7 policy ID required: true schema: type: string format: uuid - in: path name: l7RuleId description: L7 rule ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.L7Rule" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.L7Rule" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.L7Rule\nresult = client.put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId}\",\n\tcompareType = None, # The comparison type for the L7 rule (type: )\n\tinvert = None, # When true the logic of the rule is inverted. For example, with invert set to true, equal to would become not equal to (type: boolean)\n\tkey = None, # The key to use for the comparison. For example, the name of the cookie to evaluate (type: string)\n\truleType = None, # The L7 rule type (type: )\n\tvalue = None, # The value to use for the comparison. For example, the file type to compare (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/l7Policy/{l7PolicyId}/l7Rule/{l7RuleId}\", array(\n\truleType => null, // The L7 rule type (type: )\n\tvalue => null, // The value to use for the comparison. For example, the file type to compare (type: string)\n\tcompareType => null, // The comparison type for the L7 rule (type: )\n\tinvert => null, // When true the logic of the rule is inverted. For example, with invert set to true, equal to would become not equal to (type: boolean)\n\tkey => null, // The key to use for the comparison. For example, the name of the cookie to evaluate (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/l7Policy/l7Rule/edit required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener": get: summary: OVH Cloud List your loadbalancer listeners security: - oAuth2AuthCode: [] parameters: - in: query name: loadbalancerId description: Filter by loadbalancer schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.loadbalancing.Listener" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/listener/get required: true x-response-identifier: id x-expanded-response: CloudLoadbalancingListener tags: - Cloud post: summary: OVH Cloud Create a loadbalancer listener security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.CreateListener" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.Listener" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.CreateListener\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener\",\n\tprotocol = None, # Protocol of the listener (type: )\n\ttlsVersions = None, # TLS versions of the listener (type: array)\n\tdefaultPoolId = None, # The ID of the default pool (type: string)\n\tallowedCidrs = None, # The allowed CIDRs (type: array)\n\tname = None, # The name of the listener (type: string)\n\tcertificateId = None, # The ID of the secret containing the certificate (type: string)\n\tdescription = None, # The description of the listener (type: string)\n\tport = None, # Port to listen on (type: integer)\n\tloadbalancerId = None, # The ID of the loadbalancer (type: string)\n\ttimeoutMemberData = None, # Timeout member data of the listener (type: integer)\n\ttimeoutClientData = None, # Timeout client data of the listener (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener\", array(\n\tloadbalancerId => null, // The ID of the loadbalancer (type: string)\n\ttimeoutMemberData => null, // Timeout member data of the listener (type: integer)\n\ttimeoutClientData => null, // Timeout client data of the listener (type: integer)\n\tname => null, // The name of the listener (type: string)\n\tcertificateId => null, // The ID of the secret containing the certificate (type: string)\n\tdescription => null, // The description of the listener (type: string)\n\tport => null, // Port to listen on (type: integer)\n\tallowedCidrs => null, // The allowed CIDRs (type: array)\n\tprotocol => null, // Protocol of the listener (type: )\n\ttlsVersions => null, // TLS versions of the listener (type: array)\n\tdefaultPoolId => null, // The ID of the default pool (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/listener/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener/{listenerId}": delete: summary: OVH Cloud Delete loadbalancer listener security: - oAuth2AuthCode: [] parameters: - in: path name: listenerId description: Listener ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener/{listenerId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener/{listenerId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/listener/delete required: true tags: - Cloud get: summary: OVH Cloud Get details about a loadbalancer listener security: - oAuth2AuthCode: [] parameters: - in: path name: listenerId description: Listener ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.Listener" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener/{listenerId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener/{listenerId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/listener/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Edit a loadbalancer listener security: - oAuth2AuthCode: [] parameters: - in: path name: listenerId description: Listener ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.EditListener" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.Listener" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.EditListener\nresult = client.put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener/{listenerId}\",\n\tallowedCidrs = None, # The allowed CIDRs (type: array)\n\tcertificateId = None, # ID of the secret containing the certificate (type: string)\n\tdefaultPoolId = None, # ID of the default pool (type: string)\n\tdescription = None, # Description of the listener (type: string)\n\tname = None, # Name of the listener (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/listener/{listenerId}\", array(\n\tallowedCidrs => null, // The allowed CIDRs (type: array)\n\tcertificateId => null, // ID of the secret containing the certificate (type: string)\n\tdefaultPoolId => null, // ID of the default pool (type: string)\n\tdescription => null, // Description of the listener (type: string)\n\tname => null, // Name of the listener (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/listener/edit required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer": get: summary: OVH Cloud List your load balancers security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancer" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/loadbalancer/get required: true x-response-identifier: id x-expanded-response: CloudLoadbalancingLoadBalancer tags: - Cloud post: summary: OVH Cloud Create a loadbalancer security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.Loadbalancer.CreateInput" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.Loadbalancer.CreateInput\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer\",\n\tlisteners = None, # Listeners to create with the loadbalancer (type: array)\n\tname = None, # Name of the member (type: string)\n\tnetwork = None, # Network information to create the loadbalancer (type: )\n\tflavorId = None, # Loadbalancer flavor id (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer\", array(\n\tlisteners => null, // Listeners to create with the loadbalancer (type: array)\n\tname => null, // Name of the member (type: string)\n\tnetwork => null, // Network information to create the loadbalancer (type: )\n\tflavorId => null, // Loadbalancer flavor id (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/loadbalancer/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}": delete: summary: OVH Cloud Delete loadbalancer security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/loadbalancer/delete required: true tags: - Cloud get: summary: OVH Cloud Get details about a load balancer security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancer" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/loadbalancer/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Edit a loadbalancer security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.LoadbalancerEdit" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.LoadBalancer" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.LoadbalancerEdit\nresult = client.put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}\",\n\tdescription = None, # Description of the loadbalancer (type: string)\n\tname = None, # Name of the member (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}\", array(\n\tdescription => null, // Description of the loadbalancer (type: string)\n\tname => null, // Name of the member (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/loadbalancer/edit required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/associateFloatingIp": post: summary: OVH Cloud Associate an existing floating IP to a loadbalancer security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.AssociateFloatingIp" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.AssociateFloatingIp\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/associateFloatingIp\",\n\tgateway = None, # Parameters to create a gateway if required (type: cloud.network.CreateGatewaySummary, nullable)\n\tip = None, # Private loadbalancer IP to associate the floating IP with (type: )\n\tfloatingIpId = None, # Floating IP ID (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/associateFloatingIp\", array(\n\tgateway => null, // Parameters to create a gateway if required (type: cloud.network.CreateGatewaySummary, nullable)\n\tip => null, // Private loadbalancer IP to associate the floating IP with (type: )\n\tfloatingIpId => null, // Floating IP ID (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/loadbalancer/associateFloatingIp required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/floatingIp": post: summary: OVH Cloud Create a floating IP and attach it to a loadbalancer security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.CreateFloatingIp" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.CreateFloatingIp\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/floatingIp\",\n\tgateway = None, # Parameters to create a gateway if required (type: cloud.network.CreateGatewaySummary, nullable)\n\tip = None, # Private loadbalancer IP to associate the floating IP with (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/floatingIp\", array(\n\tip => null, // Private loadbalancer IP to associate the floating IP with (type: )\n\tgateway => null, // Parameters to create a gateway if required (type: cloud.network.CreateGatewaySummary, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/loadbalancer/floatingIp/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/stats": get: summary: OVH Cloud Get loadbalancer statistics security: - oAuth2AuthCode: [] parameters: - in: path name: loadBalancerId description: Load balancer ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.loadbalancer.Stats" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/stats\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/loadbalancer/{loadBalancerId}/stats"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/loadbalancer/stats/get required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool": get: summary: OVH Cloud List your loadbalancer pools security: - oAuth2AuthCode: [] parameters: - in: query name: loadbalancerId description: Filter by loadbalancer schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.loadbalancing.Pool" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/pool/get required: true x-response-identifier: id x-expanded-response: CloudLoadbalancingPool tags: - Cloud post: summary: OVH Cloud Create a loadbalancer pool security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.PoolCreate" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.Pool" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.PoolCreate\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool\",\n\talgorithm = None, # Algorithm of the pool (type: )\n\tlistenerId = None, # ID of the listener (type: string)\n\tloadbalancerId = None, # ID of the loadbalancer (type: string)\n\tname = None, # Name of the resource (type: string)\n\tprotocol = None, # Protocol of the pool (type: )\n\tsessionPersistence = None, # Information about session persistence (type: cloud.loadbalancing.PoolSessionPersistence, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool\", array(\n\talgorithm => null, // Algorithm of the pool (type: )\n\tlistenerId => null, // ID of the listener (type: string)\n\tloadbalancerId => null, // ID of the loadbalancer (type: string)\n\tname => null, // Name of the resource (type: string)\n\tprotocol => null, // Protocol of the pool (type: )\n\tsessionPersistence => null, // Information about session persistence (type: cloud.loadbalancing.PoolSessionPersistence, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/pool/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}": delete: summary: OVH Cloud Delete a loadbalancer pool security: - oAuth2AuthCode: [] parameters: - in: path name: poolId description: Pool ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/pool/delete required: true tags: - Cloud get: summary: OVH Cloud Get details about a loadbalancer pool security: - oAuth2AuthCode: [] parameters: - in: path name: poolId description: Pool ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.Pool" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/pool/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update a loadbalancer pool security: - oAuth2AuthCode: [] parameters: - in: path name: poolId description: Pool ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.PoolUpdate" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.Pool" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.PoolUpdate\nresult = client.put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}\",\n\tsessionPersistence = None, # (type: cloud.loadbalancing.PoolSessionPersistence, nullable)\n\talgorithm = None, # Algorithm of the pool (type: cloud.loadbalancing.PoolAlgorithmEnum, nullable)\n\tname = None, # Name of the resource (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}\", array(\n\tname => null, // Name of the resource (type: string, nullable)\n\tsessionPersistence => null, // (type: cloud.loadbalancing.PoolSessionPersistence, nullable)\n\talgorithm => null, // Algorithm of the pool (type: cloud.loadbalancing.PoolAlgorithmEnum, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/pool/edit required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member": get: summary: OVH Cloud List your pool members security: - oAuth2AuthCode: [] parameters: - in: path name: poolId description: Pool ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.loadbalancing.pool.Member" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/pool/member/get required: true x-response-identifier: id x-expanded-response: CloudLoadbalancingPoolMember tags: - Cloud post: summary: OVH Cloud Create pool members security: - oAuth2AuthCode: [] parameters: - in: path name: poolId description: Pool ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.pool.CreateMembers" responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.loadbalancing.pool.Member" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.pool.CreateMembers\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member\",\n\tmembers = None, # Members of a pool (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member\", array(\n\tmembers => null, // Members of a pool (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/pool/member/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member/{memberId}": delete: summary: OVH Cloud Delete a pool member security: - oAuth2AuthCode: [] parameters: - in: path name: memberId description: Member ID required: true schema: type: string format: uuid - in: path name: poolId description: Pool ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member/{memberId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member/{memberId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/pool/member/delete required: true tags: - Cloud get: summary: OVH Cloud Get details about a pool member security: - oAuth2AuthCode: [] parameters: - in: path name: memberId description: Member ID required: true schema: type: string format: uuid - in: path name: poolId description: Pool ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.pool.Member" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member/{memberId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member/{memberId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/pool/member/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update a pool member security: - oAuth2AuthCode: [] parameters: - in: path name: memberId description: Member ID required: true schema: type: string format: uuid - in: path name: poolId description: Pool ID required: true schema: type: string format: uuid - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.pool.MemberUpdate" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.loadbalancing.pool.Member" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.loadbalancing.pool.MemberUpdate\nresult = client.put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member/{memberId}\",\n\tweight = None, # Weight of a member determines the portion of requests or connections it services compared to the other members of the pool (type: integer, nullable)\n\tname = None, # Name of the resource (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/region/{regionName}/loadbalancing/pool/{poolId}/member/{memberId}\", array(\n\tweight => null, // Weight of a member determines the portion of requests or connections it services compared to the other members of the pool (type: integer, nullable)\n\tname => null, // Name of the resource (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/loadbalancing/pool/member/edit required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/network": get: summary: OVH Cloud List networks security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.Network" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/network\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/network"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/network/get required: true x-response-identifier: id x-expanded-response: CloudProjectNetwork tags: - Cloud post: summary: OVH Cloud Create a network with a gateway security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.network.CreateNetwork" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.network.CreateNetwork\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/network\",\n\tvlanId = None, # VLAN id, between 1 and 4000 (type: integer)\n\tgateway = None, # (type: cloud.network.CreateGatewaySummary, nullable)\n\tname = None, # Network name (type: string)\n\tsubnet = None, # (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/network\", array(\n\tvlanId => null, // VLAN id, between 1 and 4000 (type: integer)\n\tgateway => null, // (type: cloud.network.CreateGatewaySummary, nullable)\n\tname => null, // Network name (type: string)\n\tsubnet => null, // (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/network/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/network/{networkId}": delete: summary: OVH Cloud Delete network security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/network/{networkId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/network/{networkId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/network/delete required: true tags: - Cloud get: summary: OVH Cloud Get network security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.Network" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/network/{networkId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/network/{networkId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/network/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet": get: summary: OVH Cloud List subnets security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.project.Subnet" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/network/subnet/get required: true x-response-identifier: id x-expanded-response: CloudProjectSubnet tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId}": delete: summary: OVH Cloud Delete subnet security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: subnetId description: Subnet ID required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/network/subnet/delete required: true tags: - Cloud get: summary: OVH Cloud Get subnet security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: subnetId description: Subnet ID required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.project.Subnet" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/network/subnet/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId}/gateway": post: summary: OVH Cloud Create Gateway for existing subnet security: - oAuth2AuthCode: [] parameters: - in: path name: networkId description: Network ID required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: subnetId description: Subnet ID required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.network.CreateGatewaySummary" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.network.CreateGatewaySummary\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId}/gateway\",\n\tmodel = None, # Model of the gateway (type: )\n\tname = None, # Gateway name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/network/{networkId}/subnet/{subnetId}/gateway\", array(\n\tmodel => null, // Model of the gateway (type: )\n\tname => null, // Gateway name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/network/subnet/gateway/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/quota": get: summary: OVH Cloud List quotas security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.quota.Quotas" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/quota\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/quota"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/quota/get required: true tags: - Cloud post: summary: OVH Cloud Change project quotas on region security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectRegionQuotaCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectRegionQuotaCreation\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/quota\",\n\tname = None, # Name of the new quota (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/quota\", array(\n\tname => null, // Name of the new quota (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/quota/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/quota/allowed": get: summary: OVH Cloud Get allowed quotas on region security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.quota.AllowedQuota" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/quota/allowed\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/quota/allowed"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/quota/allowed/get required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/quota/storage": delete: summary: OVH Cloud Delete storage quota on region security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/quota/storage\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/quota/storage"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/quota/storage/delete required: true tags: - Cloud get: summary: OVH Cloud Get storage quotas on region security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.quota.storage.Quota" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/quota/storage\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/quota/storage"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/quota/storage/get required: true tags: - Cloud put: summary: OVH Cloud Update storage quota on region security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.quota.storage.QuotaUpdate" responses: '200': description: successful operation x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.quota.storage.QuotaUpdate\nresult = client.put(\"/cloud/project/{serviceName}/region/{regionName}/quota/storage\",\n\tquotaBytes = None, # New quota in bytes (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/region/{regionName}/quota/storage\", array(\n\tquotaBytes => null, // New quota in bytes (type: integer)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/quota/storage/edit required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/storage": get: summary: OVH Cloud Get S3 storage containers security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.StorageContainer" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/storage\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/storage"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/storage/get required: true x-response-identifier: name x-expanded-response: CloudStorageContainer tags: - Cloud post: summary: OVH Cloud Create S3 storage container security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.StorageContainerCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.StorageContainer" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.StorageContainerCreation\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/storage\",\n\tversioning = None, # Versioning configuration (type: cloud.StorageVersioningObject, nullable)\n\tencryption = None, # Encryption configuration (type: cloud.StorageEncryptionObject, nullable)\n\tname = None, # Container name (type: string)\n\townerId = None, # Container owner user ID (type: integer, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/storage\", array(\n\tversioning => null, // Versioning configuration (type: cloud.StorageVersioningObject, nullable)\n\tencryption => null, // Encryption configuration (type: cloud.StorageEncryptionObject, nullable)\n\tname => null, // Container name (type: string)\n\townerId => null, // Container owner user ID (type: integer, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/storage/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/storage/{name}": delete: summary: OVH Cloud Delete S3 storage container security: - oAuth2AuthCode: [] parameters: - in: path name: name description: Name required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/storage/{name}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/storage/{name}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/storage/delete required: true tags: - Cloud get: summary: OVH Cloud Get S3 storage container security: - oAuth2AuthCode: [] parameters: - in: query name: limit description: Limit the number of objects returned (1000 maximum, defaults to 1000) schema: type: integer - in: query name: marker description: List objects whose names are greater than marker schema: type: string - in: path name: name description: Name required: true schema: type: string - in: query name: prefix description: Filter objects by name prefix schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.StorageContainer" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/storage/{name}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/storage/{name}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/storage/get required: true x-response-identifier: name tags: - Cloud put: summary: OVH Cloud Update S3 storage container security: - oAuth2AuthCode: [] parameters: - in: path name: name description: Name required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.StorageContainer" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.StorageContainer" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.StorageContainer\nresult = client.put(\"/cloud/project/{serviceName}/region/{regionName}/storage/{name}\",\n\tencryption = None, # Encryption configuration (type: cloud.StorageEncryptionObject, nullable)\n\tversioning = None, # Versioning configuration (type: cloud.StorageVersioningObject, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/region/{regionName}/storage/{name}\", array(\n\tencryption => null, // Encryption configuration (type: cloud.StorageEncryptionObject, nullable)\n\tversioning => null, // Versioning configuration (type: cloud.StorageVersioningObject, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/storage/edit required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/storage/{name}/object/{objectKey}": delete: summary: OVH Cloud Delete S3 storage container object security: - oAuth2AuthCode: [] parameters: - in: path name: name description: Name required: true schema: type: string - in: path name: objectKey description: Object key required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/storage/{name}/object/{objectKey}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/storage/{name}/object/{objectKey}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/storage/object/delete required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/storage/{name}/policy/{userId}": post: summary: OVH Cloud Add S3 storage container policy security: - oAuth2AuthCode: [] parameters: - in: path name: name description: Name required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.storage.AddContainerPolicy" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.storage.AddContainerPolicy\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/storage/{name}/policy/{userId}\",\n\tobjectKey = None, # Container object key (type: string)\n\troleName = None, # Policy role (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/storage/{name}/policy/{userId}\", array(\n\tobjectKey => null, // Container object key (type: string)\n\troleName => null, // Policy role (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/storage/policy/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/storage/{name}/presign": post: summary: OVH Cloud Generate S3 presigned URLs to download or upload objects security: - oAuth2AuthCode: [] parameters: - in: path name: name description: Name required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.storage.PresignedURLInput" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.storage.PresignedURL" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.storage.PresignedURLInput\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/storage/{name}/presign\",\n\texpire = None, # URL expiration in seconds (type: integer)\n\tmethod = None, # Presigned URL method (type: )\n\tobject = None, # Object name (type: string)\n\tstorageClass = None, # Storage class (type: )\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/storage/{name}/presign\", array(\n\tobject => null, // Object name (type: string)\n\tstorageClass => null, // Storage class (type: )\n\texpire => null, // URL expiration in seconds (type: integer)\n\tmethod => null, // Presigned URL method (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/storage/presign required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/volumeBackup": get: summary: OVH Cloud List volume backups security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.volumeBackup.VolumeBackup" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/volumeBackup\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/volumeBackup"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/volumeBackup/get required: true x-response-identifier: id x-expanded-response: CloudVolumeBackupVolumeBackup tags: - Cloud post: summary: OVH Cloud Create a volume backup security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.volumeBackup.VolumeBackupCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volumeBackup.VolumeBackup" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.volumeBackup.VolumeBackupCreation\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/volumeBackup\",\n\tname = None, # name of the backup (type: string)\n\tvolumeId = None, # ID of the volume to backup (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/volumeBackup\", array(\n\tname => null, // name of the backup (type: string)\n\tvolumeId => null, // ID of the volume to backup (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/volumeBackup/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}": delete: summary: OVH Cloud Delete volume backup security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeBackupId description: Volume backup ID required: true schema: type: string format: uuid responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/volumeBackup/delete required: true tags: - Cloud get: summary: OVH Cloud Get volume backup security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeBackupId description: Volume backup ID required: true schema: type: string format: uuid responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volumeBackup.VolumeBackup" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/volumeBackup/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}/restore": post: summary: OVH Cloud Restore a volume backup on a volume security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeBackupId description: Volume backup ID required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.volumeBackup.VolumeBackupRestore" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volumeBackup.VolumeBackup" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.volumeBackup.VolumeBackupRestore\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}/restore\",\n\tvolumeId = None, # ID of the volume to restore on (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}/restore\", array(\n\tvolumeId => null, // ID of the volume to restore on (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/volumeBackup/restore required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}/volume": post: summary: OVH Cloud Create a volume from a volume backup security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeBackupId description: Volume backup ID required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.volumeBackup.VolumeCreationFromBackup" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volume.Volume" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.volumeBackup.VolumeCreationFromBackup\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}/volume\",\n\tname = None, # name of the new volume (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/volumeBackup/{volumeBackupId}/volume\", array(\n\tname => null, // name of the new volume (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/volumeBackup/volume/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/workflow/backup": get: summary: OVH Cloud List your automated backups security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.Backup" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/workflow/backup\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/workflow/backup"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/workflow/backup/get required: true x-response-identifier: id x-expanded-response: CloudBackup tags: - Cloud post: summary: OVH Cloud Create a new automated backup security: - oAuth2AuthCode: [] parameters: - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectRegionWorkflowBackupCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Backup" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectRegionWorkflowBackupCreation\nresult = client.post(\"/cloud/project/{serviceName}/region/{regionName}/workflow/backup\",\n\tinstanceId = None, # Instance ID to backup (type: string)\n\tmaxExecutionCount = None, # Number of execution to process before ending the job. Null value means that the job will never end. (type: integer, nullable)\n\tname = None, # Name of your backup job (type: string)\n\trotation = None, # Number of backup to keep (type: integer)\n\tcron = None, # Unix Cron pattern (eg: '* * * * *') (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/region/{regionName}/workflow/backup\", array(\n\tmaxExecutionCount => null, // Number of execution to process before ending the job. Null value means that the job will never end. (type: integer, nullable)\n\tname => null, // Name of your backup job (type: string)\n\trotation => null, // Number of backup to keep (type: integer)\n\tcron => null, // Unix Cron pattern (eg: '* * * * *') (type: string)\n\tinstanceId => null, // Instance ID to backup (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:region/workflow/backup/create required: true tags: - Cloud "/cloud/project/{serviceName}/region/{regionName}/workflow/backup/{backupWorkflowId}": delete: summary: OVH Cloud Delete a backup workflow process security: - oAuth2AuthCode: [] parameters: - in: path name: backupWorkflowId description: Backup workflow ID required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/region/{regionName}/workflow/backup/{backupWorkflowId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/region/{regionName}/workflow/backup/{backupWorkflowId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/workflow/backup/delete required: true tags: - Cloud get: summary: OVH Cloud Get details about a backup workflow process security: - oAuth2AuthCode: [] parameters: - in: path name: backupWorkflowId description: Backup workflow ID required: true schema: type: string - in: path name: regionName description: Region name required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Backup" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/region/{regionName}/workflow/backup/{backupWorkflowId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/region/{regionName}/workflow/backup/{backupWorkflowId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:region/workflow/backup/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/regionAvailable": get: summary: OVH Cloud List the regions on which you can ask an access to security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.AvailableRegion" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/regionAvailable\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/regionAvailable"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:regionAvailable/get required: true tags: - Cloud "/cloud/project/{serviceName}/role": get: summary: OVH Cloud Get all Roles security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.role.Roles" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/role\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/role"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:role/get required: true tags: - Cloud "/cloud/project/{serviceName}/serviceInfos": get: summary: OVH Cloud Get service information security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: The project id required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/services.Service" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/serviceInfos\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/serviceInfos"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:serviceInfos/get required: true tags: - Cloud put: summary: OVH Cloud Update service information security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: The project id required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/services.Service" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: services.Service\nresult = client.put(\"/cloud/project/{serviceName}/serviceInfos\",\n\trenew = None, # Way of handling the renew (type: service.RenewType, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/serviceInfos\", array(\n\trenew => null, // Way of handling the renew (type: service.RenewType, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:serviceInfos/edit required: true tags: - Cloud "/cloud/project/{serviceName}/snapshot": get: summary: OVH Cloud Get snapshots security: - oAuth2AuthCode: [] parameters: - in: query name: flavorType description: Get compatible snapshots with flavor type schema: type: string - in: query name: region description: Region schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.image.Image" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/snapshot\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/snapshot"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:snapshot/get required: true x-response-identifier: id x-expanded-response: CloudImageImage tags: - Cloud "/cloud/project/{serviceName}/snapshot/{imageId}": delete: summary: OVH Cloud Delete a snapshot security: - oAuth2AuthCode: [] parameters: - in: path name: imageId description: Image ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.image.Image" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/snapshot/{imageId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/snapshot/{imageId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:snapshot/delete required: true tags: - Cloud get: summary: OVH Cloud Get snapshot details security: - oAuth2AuthCode: [] parameters: - in: path name: imageId description: Image ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.image.Image" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/snapshot/{imageId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/snapshot/{imageId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:snapshot/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/sshkey": get: summary: OVH Cloud Get SSH keys security: - oAuth2AuthCode: [] parameters: - in: query name: region description: Region schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.sshkey.SshKey" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/sshkey\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/sshkey"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:sshkey/get required: true x-response-identifier: id tags: - Cloud post: summary: OVH Cloud Create SSH key security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectSshkeyCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.sshkey.SshKeyDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectSshkeyCreation\nresult = client.post(\"/cloud/project/{serviceName}/sshkey\",\n\tpublicKey = None, # SSH public key (type: string)\n\tregion = None, # Region to create SSH key (type: string, nullable)\n\tname = None, # SSH key name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/sshkey\", array(\n\tpublicKey => null, // SSH public key (type: string)\n\tregion => null, // Region to create SSH key (type: string, nullable)\n\tname => null, // SSH key name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:sshkey/create required: true tags: - Cloud "/cloud/project/{serviceName}/sshkey/{keyId}": delete: summary: OVH Cloud Delete SSH key security: - oAuth2AuthCode: [] parameters: - in: path name: keyId description: Key ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/sshkey/{keyId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/sshkey/{keyId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:sshkey/delete required: true tags: - Cloud get: summary: OVH Cloud Get SSH key security: - oAuth2AuthCode: [] parameters: - in: path name: keyId description: Key ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.sshkey.SshKeyDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/sshkey/{keyId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/sshkey/{keyId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:sshkey/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/stack": get: summary: OVH Cloud Get stacks security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.stack.Stack" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/stack\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/stack"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:stack/get required: true x-response-identifier: name x-expanded-response: CloudStackStack tags: - Cloud "/cloud/project/{serviceName}/stack/{stackId}": get: summary: OVH Cloud Get stack security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: stackId description: Stack ID required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.stack.Stack" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/stack/{stackId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/stack/{stackId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:stack/get required: true x-response-identifier: name tags: - Cloud "/cloud/project/{serviceName}/storage": get: summary: OVH Cloud Get SWIFT storage containers security: - oAuth2AuthCode: [] parameters: - in: query name: includeType description: Include container type schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.storage.Container" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/storage\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/storage"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:storage/get required: true tags: - Cloud post: summary: OVH Cloud Create SWIFT container security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectStorageCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.storage.Container" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectStorageCreation\nresult = client.post(\"/cloud/project/{serviceName}/storage\",\n\tarchive = None, # Archive container flag (type: boolean)\n\tcontainerName = None, # Container name (type: string)\n\tregion = None, # Region (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/storage\", array(\n\tarchive => null, // Archive container flag (type: boolean)\n\tcontainerName => null, // Container name (type: string)\n\tregion => null, // Region (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:storage/create required: true tags: - Cloud "/cloud/project/{serviceName}/storage/access": post: summary: OVH Cloud Access to SWIFT storage API security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.storage.ContainerAccess" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/storage/access\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/storage/access"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:storage/access/create required: true tags: - Cloud "/cloud/project/{serviceName}/storage/quota": get: summary: OVH Cloud List storage quotas security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.storage.Quota" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/storage/quota\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/storage/quota"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:storage/quota/get required: true tags: - Cloud "/cloud/project/{serviceName}/storage/{containerId}": delete: summary: OVH Cloud Delete SWIFT container security: - oAuth2AuthCode: [] parameters: - in: path name: containerId description: Container ID required: true schema: type: string - in: query name: recursive description: Recursively delete objects and container schema: type: boolean - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/storage/{containerId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/storage/{containerId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:storage/delete required: true tags: - Cloud get: summary: OVH Cloud Get SWIFT storage container security: - oAuth2AuthCode: [] parameters: - in: path name: containerId description: Container ID required: true schema: type: string - in: query name: noObjects description: Do not return container objects schema: type: boolean - in: query name: prefix description: Filter objects by name prefix schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.storage.ContainerDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/storage/{containerId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/storage/{containerId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:storage/get required: true x-response-identifier: name tags: - Cloud put: summary: OVH Cloud Update SWIFT storage container security: - oAuth2AuthCode: [] parameters: - in: path name: containerId description: Container ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectStorageUpdate" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectStorageUpdate\nresult = client.put(\"/cloud/project/{serviceName}/storage/{containerId}\",\n\tcontainerType = None, # Container type (type: cloud.storage.TypeEnum, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/storage/{containerId}\", array(\n\tcontainerType => null, // Container type (type: cloud.storage.TypeEnum, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:storage/edit required: true tags: - Cloud "/cloud/project/{serviceName}/storage/{containerId}/cors": delete: summary: OVH Cloud Delete CORS support on SWIFT container security: - oAuth2AuthCode: [] parameters: - in: path name: containerId description: Container ID required: true schema: type: string - in: query name: origin description: Delete this origin required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/storage/{containerId}/cors\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/storage/{containerId}/cors"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:storage/cors/delete required: true tags: - Cloud post: summary: OVH Cloud Add CORS support on SWIFT container security: - oAuth2AuthCode: [] parameters: - in: path name: containerId description: Container ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectStorageCorsCreation" responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectStorageCorsCreation\nresult = client.post(\"/cloud/project/{serviceName}/storage/{containerId}/cors\",\n\torigin = None, # Allow this origin (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/storage/{containerId}/cors\", array(\n\torigin => null, // Allow this origin (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:storage/cors/create required: true tags: - Cloud "/cloud/project/{serviceName}/storage/{containerId}/publicUrl": post: summary: OVH Cloud Get a public temporary URL to access one of your SWIFT object security: - oAuth2AuthCode: [] parameters: - in: path name: containerId description: Container ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectStoragePublicUrlCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.storage.ContainerObjectTempURL" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectStoragePublicUrlCreation\nresult = client.post(\"/cloud/project/{serviceName}/storage/{containerId}/publicUrl\",\n\texpirationDate = None, # Temporary URL expiration (type: string)\n\tobjectName = None, # Object name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/storage/{containerId}/publicUrl\", array(\n\texpirationDate => null, // Temporary URL expiration (type: string)\n\tobjectName => null, // Object name (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:storage/publicUrl/create required: true tags: - Cloud "/cloud/project/{serviceName}/storage/{containerId}/static": post: summary: OVH Cloud Deploy your SWIFT container files as a static web site security: - oAuth2AuthCode: [] parameters: - in: path name: containerId description: Container ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/storage/{containerId}/static\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/storage/{containerId}/static"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:storage/static/create required: true tags: - Cloud "/cloud/project/{serviceName}/storage/{containerId}/user": post: summary: OVH Cloud Create openstack user with only access to this SWIFT container security: - oAuth2AuthCode: [] parameters: - in: path name: containerId description: Container ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectStorageUserCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.UserDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectStorageUserCreation\nresult = client.post(\"/cloud/project/{serviceName}/storage/{containerId}/user\",\n\tright = None, # User right (all, read, write) (type: )\n\tdescription = None, # User description (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/storage/{containerId}/user\", array(\n\tdescription => null, // User description (type: string, nullable)\n\tright => null, // User right (all, read, write) (type: )\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:storage/user/create required: true tags: - Cloud "/cloud/project/{serviceName}/terminate": post: summary: OVH Cloud Ask for the termination of your service description: Ask for the termination of your service. Admin contact of this service will receive a termination token by email in order to confirm its termination with /confirmTermination endpoint. security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: The project id required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: string x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/terminate\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/terminate"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:terminate required: true tags: - Cloud "/cloud/project/{serviceName}/user": get: summary: OVH Cloud Get all users security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.user.User" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/user\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/user"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/get required: true x-response-identifier: id x-expanded-response: CloudUserUser tags: - Cloud post: summary: OVH Cloud Create user security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectUserCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.UserDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectUserCreation\nresult = client.post(\"/cloud/project/{serviceName}/user\",\n\trole = None, # Openstack keystone role name (type: cloud.user.RoleEnum, nullable)\n\troles = None, # Openstack keystone roles names (type: array, nullable)\n\tdescription = None, # User description (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/user\", array(\n\troles => null, // Openstack keystone roles names (type: array, nullable)\n\tdescription => null, // User description (type: string, nullable)\n\trole => null, // Openstack keystone role name (type: cloud.user.RoleEnum, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:user/create required: true tags: - Cloud "/cloud/project/{serviceName}/user/{userId}": delete: summary: OVH Cloud Delete user security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/delete required: true tags: - Cloud get: summary: OVH Cloud Get user details security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.User" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/user/{userId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/user/{userId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/configuration": get: summary: OVH Cloud Get your client configuration security: - oAuth2AuthCode: [] parameters: - in: query name: region description: Region schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.Configuration" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/user/{userId}/configuration\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/user/{userId}/configuration"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/configuration/get required: true tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/openrc": get: summary: OVH Cloud Get RC file of OpenStack security: - oAuth2AuthCode: [] parameters: - in: query name: region description: Region required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer - in: query name: version description: Identity API version schema: "$ref": "#/components/schemas/cloud.user.OpenrcVersionEnum" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.Openrc" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/user/{userId}/openrc\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/user/{userId}/openrc"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/openrc/get required: true tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/policy": get: summary: OVH Cloud Export user storage policy security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.storage.PolicyRaw" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/user/{userId}/policy\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/user/{userId}/policy"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/policy/get required: true tags: - Cloud post: summary: OVH Cloud Import user storage policy security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.storage.PolicyRaw" responses: '200': description: successful operation x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.storage.PolicyRaw\nresult = client.post(\"/cloud/project/{serviceName}/user/{userId}/policy\",\n\tpolicy = None, # Raw storage policy (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/user/{userId}/policy\", array(\n\tpolicy => null, // Raw storage policy (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:user/policy/create required: true tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/rclone": get: summary: OVH Cloud Get rclone configuration file security: - oAuth2AuthCode: [] parameters: - in: query name: region description: Region required: true schema: type: string - in: query name: service description: Service schema: "$ref": "#/components/schemas/cloud.user.RCloneServiceEnum" - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.Rclone" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/user/{userId}/rclone\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/user/{userId}/rclone"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/rclone/get required: true tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/regeneratePassword": post: summary: OVH Cloud Regenerate user password security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.UserDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/user/{userId}/regeneratePassword\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/user/{userId}/regeneratePassword"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/regeneratePassword required: true tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/role": get: summary: OVH Cloud Get user roles security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.role.Role" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/user/{userId}/role\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/user/{userId}/role"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/role/get required: true x-response-identifier: id tags: - Cloud post: summary: OVH Cloud Add a role to a user security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectUserRoleCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.UserDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectUserRoleCreation\nresult = client.post(\"/cloud/project/{serviceName}/user/{userId}/role\",\n\troleId = None, # Role id (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/user/{userId}/role\", array(\n\troleId => null, // Role id (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:user/role/create required: true tags: - Cloud put: summary: OVH Cloud Update roles of a user security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectUserRoleUpdate" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.UserDetail" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectUserRoleUpdate\nresult = client.put(\"/cloud/project/{serviceName}/user/{userId}/role\",\n\trolesIds = None, # Roles ids (type: array)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/user/{userId}/role\", array(\n\trolesIds => null, // Roles ids (type: array)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:user/role/edit required: true tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/role/{roleId}": delete: summary: OVH Cloud Remove role for a user security: - oAuth2AuthCode: [] parameters: - in: path name: roleId description: Role ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/user/{userId}/role/{roleId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/user/{userId}/role/{roleId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/role/delete required: true tags: - Cloud get: summary: OVH Cloud Get role detail security: - oAuth2AuthCode: [] parameters: - in: path name: roleId description: Role ID required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.role.Role" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/user/{userId}/role/{roleId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/user/{userId}/role/{roleId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/role/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/s3Credentials": get: summary: OVH Cloud List your S3 credentials security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.user.S3Credentials" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/user/{userId}/s3Credentials\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/user/{userId}/s3Credentials"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/s3Credentials/get required: true x-response-identifier: access x-expanded-response: CloudUserS3Credentials tags: - Cloud post: summary: OVH Cloud Create a new S3 credentials for an user security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.S3CredentialsWithSecret" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/user/{userId}/s3Credentials\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/user/{userId}/s3Credentials"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/s3Credentials/create required: true tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/s3Credentials/{access}": delete: summary: OVH Cloud Delete an S3 credential security: - oAuth2AuthCode: [] parameters: - in: path name: access description: Access required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/user/{userId}/s3Credentials/{access}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/user/{userId}/s3Credentials/{access}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/s3Credentials/delete required: true tags: - Cloud get: summary: OVH Cloud Get details about an S3 credential security: - oAuth2AuthCode: [] parameters: - in: path name: access description: Access required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.S3Credentials" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/user/{userId}/s3Credentials/{access}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/user/{userId}/s3Credentials/{access}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/s3Credentials/get required: true x-response-identifier: access tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/s3Credentials/{access}/secret": post: summary: OVH Cloud Display secret from a S3 credential security: - oAuth2AuthCode: [] parameters: - in: path name: access description: Access required: true schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.user.S3CredentialsSecretOnly" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/user/{userId}/s3Credentials/{access}/secret\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/user/{userId}/s3Credentials/{access}/secret"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:user/s3Credentials/secret/display required: true tags: - Cloud "/cloud/project/{serviceName}/user/{userId}/token": post: summary: OVH Cloud Get token for user security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: userId description: User ID required: true schema: type: integer requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectUserTokenCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.authentication.Token" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectUserTokenCreation\nresult = client.post(\"/cloud/project/{serviceName}/user/{userId}/token\",\n\tpassword = None, # User password (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/user/{userId}/token\", array(\n\tpassword => null, // User password (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:user/token/create required: true tags: - Cloud "/cloud/project/{serviceName}/volume": get: summary: OVH Cloud Get volumes security: - oAuth2AuthCode: [] parameters: - in: query name: region description: Volume region schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.volume.Volume" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/volume\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/volume"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:volume/get required: true x-response-identifier: id x-expanded-response: CloudVolumeVolume tags: - Cloud post: summary: OVH Cloud Create a volume security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectVolumeCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volume.Volume" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectVolumeCreation\nresult = client.post(\"/cloud/project/{serviceName}/volume\",\n\timageId = None, # Id of image to create a bootable volume (type: string, nullable)\n\tname = None, # Volume name (type: string, nullable)\n\tregion = None, # Volume region (type: string)\n\tsize = None, # Volume size (in GiB) (type: integer)\n\tsnapshotId = None, # Source snapshot id (type: string, nullable)\n\ttype = None, # Volume type (type: )\n\tdescription = None, # Volume description (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/volume\", array(\n\ttype => null, // Volume type (type: )\n\tdescription => null, // Volume description (type: string, nullable)\n\timageId => null, // Id of image to create a bootable volume (type: string, nullable)\n\tname => null, // Volume name (type: string, nullable)\n\tregion => null, // Volume region (type: string)\n\tsize => null, // Volume size (in GiB) (type: integer)\n\tsnapshotId => null, // Source snapshot id (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:volume/create required: true tags: - Cloud "/cloud/project/{serviceName}/volume/snapshot": get: summary: OVH Cloud Get volume snapshots security: - oAuth2AuthCode: [] parameters: - in: query name: region description: Snapshots region schema: type: string - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: type: array items: "$ref": "#/components/schemas/cloud.volume.Snapshot" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/volume/snapshot\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/volume/snapshot"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:volume/snapshot/get required: true x-response-identifier: id x-expanded-response: CloudVolumeSnapshot tags: - Cloud "/cloud/project/{serviceName}/volume/snapshot/{snapshotId}": delete: summary: OVH Cloud Delete a volume snapshot security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: snapshotId description: Snapshot ID required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/volume/snapshot/{snapshotId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/volume/snapshot/{snapshotId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:volume/snapshot/delete required: true tags: - Cloud get: summary: OVH Cloud Get volume snapshot details security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: snapshotId description: Snapshot ID required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volume.Snapshot" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/volume/snapshot/{snapshotId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/volume/snapshot/{snapshotId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:volume/snapshot/get required: true x-response-identifier: id tags: - Cloud "/cloud/project/{serviceName}/volume/{volumeId}": delete: summary: OVH Cloud Delete a volume security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeId description: Volume ID required: true schema: type: string responses: '200': description: successful operation x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/cloud/project/{serviceName}/volume/{volumeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- delete("/cloud/project/{serviceName}/volume/{volumeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:volume/delete required: true tags: - Cloud get: summary: OVH Cloud Get volume details security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeId description: Volume ID required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volume.Volume" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/volume/{volumeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/volume/{volumeId}"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:volume/get required: true x-response-identifier: id tags: - Cloud put: summary: OVH Cloud Update a volume security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeId description: Volume ID required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectVolumeUpdate" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volume.Volume" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectVolumeUpdate\nresult = client.put(\"/cloud/project/{serviceName}/volume/{volumeId}\",\n\tname = None, # Volume name (type: string, nullable)\n\tdescription = None, # Volume description (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "put(\"/cloud/project/{serviceName}/volume/{volumeId}\", array(\n\tname => null, // Volume name (type: string, nullable)\n\tdescription => null, // Volume description (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:volume/edit required: true tags: - Cloud "/cloud/project/{serviceName}/volume/{volumeId}/attach": post: summary: OVH Cloud Attach a volume on an instance security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeId description: Volume ID required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectVolumeAttachCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volume.Volume" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectVolumeAttachCreation\nresult = client.post(\"/cloud/project/{serviceName}/volume/{volumeId}/attach\",\n\tinstanceId = None, # Instance id (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/volume/{volumeId}/attach\", array(\n\tinstanceId => null, // Instance id (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:volume/attach required: true tags: - Cloud "/cloud/project/{serviceName}/volume/{volumeId}/detach": post: summary: OVH Cloud Detach a volume from an instance security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeId description: Volume ID required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectVolumeDetachCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volume.Volume" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectVolumeDetachCreation\nresult = client.post(\"/cloud/project/{serviceName}/volume/{volumeId}/detach\",\n\tinstanceId = None, # Instance id (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/volume/{volumeId}/detach\", array(\n\tinstanceId => null, // Instance id (type: string)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:volume/detach required: true tags: - Cloud "/cloud/project/{serviceName}/volume/{volumeId}/snapshot": post: summary: OVH Cloud Snapshot a volume security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeId description: Volume ID required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectVolumeSnapshotCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volume.Snapshot" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectVolumeSnapshotCreation\nresult = client.post(\"/cloud/project/{serviceName}/volume/{volumeId}/snapshot\",\n\tdescription = None, # Snapshot description (type: string, nullable)\n\tname = None, # Snapshot name (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/volume/{volumeId}/snapshot\", array(\n\tdescription => null, // Snapshot description (type: string, nullable)\n\tname => null, // Snapshot name (type: string, nullable)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:volume/snapshot/create required: true tags: - Cloud "/cloud/project/{serviceName}/volume/{volumeId}/upsize": post: summary: OVH Cloud Extend a volume security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string - in: path name: volumeId description: Volume ID required: true schema: type: string requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/cloud.ProjectVolumeUpsizeCreation" responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.volume.Volume" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: cloud.ProjectVolumeUpsizeCreation\nresult = client.post(\"/cloud/project/{serviceName}/volume/{volumeId}/upsize\",\n\tsize = None, # New volume size (in GiB) (must be greater than current one) (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: "post(\"/cloud/project/{serviceName}/volume/{volumeId}/upsize\", array(\n\tsize => null, // New volume size (in GiB) (must be greater than current one) (type: integer)\n));\n\nprint_r($result);\n?>" x-iam-actions: - name: publicCloudProject:apiovh:volume/upsize required: true tags: - Cloud "/cloud/project/{serviceName}/vrack": get: summary: OVH Cloud Get the linked vRack on your project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Vrack" x-badges: - color: green label: Stable production version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/cloud/project/{serviceName}/vrack\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- get("/cloud/project/{serviceName}/vrack"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:vrack/get required: true tags: - Cloud post: summary: OVH Cloud Order and attach a new vRack on your project security: - oAuth2AuthCode: [] parameters: - in: path name: serviceName description: Service name required: true schema: type: string responses: '200': description: successful operation content: application/json: schema: "$ref": "#/components/schemas/cloud.Operation" x-badges: - color: blue label: Beta version x-code-samples: - lang: python label: Python source: "'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/cloud/project/{serviceName}/vrack\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))" - lang: php label: PHP source: |- post("/cloud/project/{serviceName}/vrack"); print_r($result); ?> x-iam-actions: - name: publicCloudProject:apiovh:vrack/create required: true tags: - Cloud tags: - name: Cloud