OVH Cloud OVHcloud API specification

naftiko: 1.0.0-alpha2
info:
  label: OVH Cloud OVHcloud API specification
  description: Specification for OVHcloud API
  tags:
  - Ovh
  - Cloud
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: ovh-cloud
    baseUri: https://api.us.ovhcloud.com/v1
    description: OVH Cloud OVHcloud API specification HTTP API.
    authentication:
      type: bearer
      token: '{{OVH_CLOUD_TOKEN}}'
    resources:
    - name: cloud-order
      path: /cloud/order
      operations:
      - name: get-cloud-order
        method: GET
        description: OVH Cloud Get all cloud pending orders
        inputParameters:
        - name: planCode
          in: query
          type: string
          description: Order plan code
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-order-rule-availability
      path: /cloud/order/rule/availability
      operations:
      - name: get-cloud-order-rule-availability
        method: GET
        description: OVH Cloud Get product availability
        inputParameters:
        - name: addonFamily
          in: query
          type: string
          description: Addon family filter
        - name: ovhSubsidiary
          in: query
          type: string
          required: true
          description: OVH subsidiary
        - name: planCode
          in: query
          type: string
          description: Plan code filter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-order-rule-instancecategory
      path: /cloud/order/rule/instanceCategory
      operations:
      - name: get-cloud-order-rule-instancecategory
        method: GET
        description: OVH Cloud Get instance categories
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project
      path: /cloud/project
      operations:
      - name: get-cloud-project
        method: GET
        description: OVH Cloud List available services
        inputParameters:
        - name: iamTags
          in: query
          type: object
          description: Filter resources on IAM tags
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename
      path: /cloud/project/{serviceName}
      operations:
      - name: get-cloud-project-servicename
        method: GET
        description: OVH Cloud Get this object properties
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-cloud-project-servicename
        method: PUT
        description: OVH Cloud Alter this object properties
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-activatemonthlybilling
      path: /cloud/project/{serviceName}/activateMonthlyBilling
      operations:
      - name: post-cloud-project-servicename-activatemonthlybi
        method: POST
        description: OVH Cloud Activate monthly billing on multiple instances
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-capabilities-container
      path: /cloud/project/{serviceName}/capabilities/containerRegistry
      operations:
      - name: get-cloud-project-servicename-capabilities-conta
        method: GET
        description: OVH Cloud List container registry capabilities per region
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-capabilities-kube-admi
      path: /cloud/project/{serviceName}/capabilities/kube/admissionplugins
      operations:
      - name: get-cloud-project-servicename-capabilities-kube-
        method: GET
        description: OVH Cloud List of admissionPlugins managed by MKS product that can be enabled or disabled.
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-capabilities-kube-flav
      path: /cloud/project/{serviceName}/capabilities/kube/flavors
      operations:
      - name: get-cloud-project-servicename-capabilities-kube-
        method: GET
        description: OVH Cloud List Kubernetes available flavors for a region
        inputParameters:
        - name: region
          in: query
          type: string
          description: 'The region to list available flavors from. Example: GRA11.'
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-capabilities-kube-log-
      path: /cloud/project/{serviceName}/capabilities/kube/log/kind
      operations:
      - name: get-cloud-project-servicename-capabilities-kube-
        method: GET
        description: OVH Cloud List available log kinds
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-capabilities-kube-log-
      path: /cloud/project/{serviceName}/capabilities/kube/log/kind/{name}
      operations:
      - name: get-cloud-project-servicename-capabilities-kube-
        method: GET
        description: OVH Cloud Get a log kind
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
          description: Name
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-capabilities-kube-regi
      path: /cloud/project/{serviceName}/capabilities/kube/regions
      operations:
      - name: get-cloud-project-servicename-capabilities-kube-
        method: GET
        description: OVH Cloud List Kubernetes regions where cluster creation is possible.
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-capabilities-loadbalan
      path: /cloud/project/{serviceName}/capabilities/loadbalancer/region
      operations:
      - name: get-cloud-project-servicename-capabilities-loadb
        method: GET
        description: OVH Cloud List all available regions
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-capabilities-loadbalan
      path: /cloud/project/{serviceName}/capabilities/loadbalancer/region/{regionName}
      operations:
      - name: get-cloud-project-servicename-capabilities-loadb
        method: GET
        description: OVH Cloud Get specific information of a region
        inputParameters:
        - name: regionName
          in: path
          type: string
          required: true
          description: Region name
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-capabilities-productav
      path: /cloud/project/{serviceName}/capabilities/productAvailability
      operations:
      - name: get-cloud-project-servicename-capabilities-produ
        method: GET
        description: OVH Cloud List product availability
        inputParameters:
        - name: addonFamily
          in: query
          type: string
          description: Addon family filter
        - name: ovhSubsidiary
          in: query
          type: string
          required: true
          description: OVH subsidiary
        - name: planCode
          in: query
          type: string
          description: Plan code filter
        - name: planFamily
          in: query
          type: string
          description: Plan family filter (deprecated, use addonFamily instead)
        - name: product
          in: query
          type: string
          description: Product filter
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-confirmtermination
      path: /cloud/project/{serviceName}/confirmTermination
      operations:
      - name: post-cloud-project-servicename-confirmterminatio
        method: POST
        description: OVH Cloud Confirm service termination
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: The project id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-containerregistry
      path: /cloud/project/{serviceName}/containerRegistry
      operations:
      - name: get-cloud-project-servicename-containerregistry
        method: GET
        description: OVH Cloud List registries of the project
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post-cloud-project-servicename-containerregistry
        method: POST
        description: OVH Cloud Create a new registry
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-containerregistry-regi
      path: /cloud/project/{serviceName}/containerRegistry/{registryID}
      operations:
      - name: delete-cloud-project-servicename-containerregist
        method: DELETE
        description: OVH Cloud Delete a registry
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get-cloud-project-servicename-containerregistry-
        method: GET
        description: OVH Cloud Get the registry information
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-cloud-project-servicename-containerregistry-
        method: PUT
        description: OVH Cloud Update the registry
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-containerregistry-regi
      path: /cloud/project/{serviceName}/containerRegistry/{registryID}/capabilities/plan
      operations:
      - name: get-cloud-project-servicename-containerregistry-
        method: GET
        description: OVH Cloud Get available plans for the current registry.
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-containerregistry-regi
      path: /cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/management
      operations:
      - name: get-cloud-project-servicename-containerregistry-
        method: GET
        description: OVH Cloud List your IP restrictions applied on Harbor UI and API
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-cloud-project-servicename-containerregistry-
        method: PUT
        description: OVH Cloud Replace IP restrictions applied on Harbor UI and API
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-containerregistry-regi
      path: /cloud/project/{serviceName}/containerRegistry/{registryID}/ipRestrictions/registry
      operations:
      - name: get-cloud-project-servicename-containerregistry-
        method: GET
        description: OVH Cloud List your IP restrictions applied on artifact manager component
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-cloud-project-servicename-containerregistry-
        method: PUT
        description: OVH Cloud Replace IP restrictions applied on artifact manager component (Docker, Helm, etc...)
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-containerregistry-regi
      path: /cloud/project/{serviceName}/containerRegistry/{registryID}/openIdConnect
      operations:
      - name: delete-cloud-project-servicename-containerregist
        method: DELETE
        description: OVH Cloud Delete the registry's OIDC Configuration
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get-cloud-project-servicename-containerregistry-
        method: GET
        description: OVH Cloud Get the registry's OIDC configuration
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post-cloud-project-servicename-containerregistry
        method: POST
        description: OVH Cloud Add or replace the registry's OIDC configuration
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-cloud-project-servicename-containerregistry-
        method: PUT
        description: OVH Cloud Edit the registry's OIDC configuration
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-containerregistry-regi
      path: /cloud/project/{serviceName}/containerRegistry/{registryID}/plan
      operations:
      - name: get-cloud-project-servicename-containerregistry-
        method: GET
        description: OVH Cloud Show the actual plan of the registry.
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-cloud-project-servicename-containerregistry-
        method: PUT
        description: OVH Cloud Update the plan of a registry.
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-containerregistry-regi
      path: /cloud/project/{serviceName}/containerRegistry/{registryID}/users
      operations:
      - name: get-cloud-project-servicename-containerregistry-
        method: GET
        description: OVH Cloud List registry user
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post-cloud-project-servicename-containerregistry
        method: POST
        description: OVH Cloud Create a new registry user
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-containerregistry-regi
      path: /cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}
      operations:
      - name: delete-cloud-project-servicename-containerregist
        method: DELETE
        description: OVH Cloud Delete a registry user
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        - name: userID
          in: path
          type: string
          required: true
          description: UserID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get-cloud-project-servicename-containerregistry-
        method: GET
        description: OVH Cloud Get registry user
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        - name: userID
          in: path
          type: string
          required: true
          description: UserID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-containerregistry-regi
      path: /cloud/project/{serviceName}/containerRegistry/{registryID}/users/{userID}/setAsAdmin
      operations:
      - name: put-cloud-project-servicename-containerregistry-
        method: PUT
        description: OVH Cloud Set the user as Admin
        inputParameters:
        - name: registryID
          in: path
          type: string
          required: true
          description: RegistryID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        - name: userID
          in: path
          type: string
          required: true
          description: UserID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-database-availability
      path: /cloud/project/{serviceName}/database/availability
      operations:
      - name: get-cloud-project-servicename-database-availabil
        method: GET
        description: OVH Cloud Get database engines availability
        inputParameters:
        - name: action
          in: query
          type: string
          description: Type of action on which restrict the availabilities
        - name: clusterId
          in: query
          type: string
          description: Cluster ID on which restrict the availabilities
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        - name: target
          in: query
          type: string
          description: Type of target on which restrict the availabilities
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-database-capabilities
      path: /cloud/project/{serviceName}/database/capabilities
      operations:
      - name: get-cloud-project-servicename-database-capabilit
        method: GET
        description: OVH Cloud Get database engines capabilities
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-database-cassandra
      path: /cloud/project/{serviceName}/database/cassandra
      operations:
      - name: get-cloud-project-servicename-database-cassandra
        method: GET
        description: OVH Cloud List all the cassandra clusters of the project
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: post-cloud-project-servicename-database-cassandr
        method: POST
        description: OVH Cloud Create a new cassandra cluster
        inputParameters:
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-database-cassandra-clu
      path: /cloud/project/{serviceName}/database/cassandra/{clusterId}
      operations:
      - name: delete-cloud-project-servicename-database-cassan
        method: DELETE
        description: OVH Cloud Delete a cassandra cluster
        inputParameters:
        - name: clusterId
          in: path
          type: string
          required: true
          description: Cluster ID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: get-cloud-project-servicename-database-cassandra
        method: GET
        description: OVH Cloud Get cassandra cluster properties
        inputParameters:
        - name: clusterId
          in: path
          type: string
          required: true
          description: Cluster ID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-cloud-project-servicename-database-cassandra
        method: PUT
        description: OVH Cloud Update an existing cassandra cluster
        inputParameters:
        - name: clusterId
          in: path
          type: string
          required: true
          description: Cluster ID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-database-cassandra-clu
      path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/advancedConfiguration
      operations:
      - name: get-cloud-project-servicename-database-cassandra
        method: GET
        description: OVH Cloud Get cassandra advanced configuration
        inputParameters:
        - name: clusterId
          in: path
          type: string
          required: true
          description: Cluster ID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: put-cloud-project-servicename-database-cassandra
        method: PUT
        description: OVH Cloud Update cassandra advanced configuration
        inputParameters:
        - name: clusterId
          in: path
          type: string
          required: true
          description: Cluster ID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-database-cassandra-clu
      path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/backup
      operations:
      - name: get-cloud-project-servicename-database-cassandra
        method: GET
        description: OVH Cloud List backups of the cassandra
        inputParameters:
        - name: clusterId
          in: path
          type: string
          required: true
          description: Cluster ID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-database-cassandra-clu
      path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/backup/{backupId}
      operations:
      - name: get-cloud-project-servicename-database-cassandra
        method: GET
        description: OVH Cloud Get cassandra backups
        inputParameters:
        - name: backupId
          in: path
          type: string
          required: true
          description: Backup ID
        - name: clusterId
          in: path
          type: string
          required: true
          description: Cluster ID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-database-cassandra-clu
      path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/capabilities/advancedConfiguration
      operations:
      - name: get-cloud-project-servicename-database-cassandra
        method: GET
        description: OVH Cloud Get cassandra advanced configuration fields
        inputParameters:
        - name: clusterId
          in: path
          type: string
          required: true
          description: Cluster ID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: cloud-project-servicename-database-cassandra-clu
      path: /cloud/project/{serviceName}/database/cassandra/{clusterId}/capabilities/integration
      operations:
      - name: get-cloud-project-servicename-database-cassandra
        method: GET
        description: OVH Cloud Get integration capabilities related to the cassandra service
        inputParameters:
        - name: clusterId
          in: path
          type: string
          required: true
          description: Cluster ID
        - name: serviceName
          in: path
          type: string
          required: true
          description: Service name
        outputRawFo

# --- truncated at 32 KB (107 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ovh-cloud/refs/heads/main/capabilities/ovh-cloud-capability.yaml