{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/v2"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"common.CurrentTask":{"type":"object","description":"Asynchronous operation currently running","properties":{"errors":{"type":"array","description":"Errors that occurred on the task","nullable":true,"items":{"$ref":"#/components/schemas/common.TaskError"},"readOnly":true},"id":{"type":"string","description":"Identifier of the current task","format":"uuid","readOnly":true},"link":{"type":"string","description":"Link to the task details","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.CurrentTaskStatusEnum"}],"description":"Current global status of the current task","nullable":true,"readOnly":true},"type":{"type":"string","description":"Type of the current task","readOnly":true}}},"common.CurrentTaskStatusEnum":{"type":"string","description":"Current status of a task. A task in ERROR cannot be retried without your inputs. PENDING tasks will be executed as soon as possible. A RUNNING task is currently executing your original request. SCHEDULED is used for tasks that will be executed in the future.","enum":["ERROR","PENDING","RUNNING","SCHEDULED","WAITING_USER_INPUT"]},"common.ResourceStatusEnum":{"type":"string","description":"Current status of a resource","enum":["CREATING","CREATION_PLANNED","DELETING","ERROR","OUT_OF_SYNC","READY","SUSPENDED","UNKNOWN","UPDATING"]},"common.TaskError":{"type":"object","description":"Errors that occurred on the task","properties":{"message":{"type":"string","description":"Error description","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"},"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., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"publicCloud.storage.object.Bucket":{"type":"object","description":"An S3™ compatible object storage bucket","properties":{"checksum":{"type":"string","description":"Computed hash representing the current target specification value","readOnly":true},"createdAt":{"type":"string","description":"Creation date of the bucket","format":"date-time","readOnly":true},"currentState":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketCurrentState"}],"description":"Current observed state of the bucket","nullable":true,"readOnly":true},"currentTasks":{"type":"array","description":"Ongoing asynchronous tasks related to the bucket","nullable":true,"items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"id":{"type":"string","description":"Bucket name (used as unique identifier)","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Bucket readiness in the system","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketTargetSpec"}],"description":"Last target specification of the bucket","readOnly":true},"updatedAt":{"type":"string","description":"Last update date of the bucket","format":"date-time","readOnly":true}}},"publicCloud.storage.object.BucketCreation":{"type":"object","description":"Payload to create an S3™ compatible bucket","properties":{"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketTargetSpec"}],"description":"Desired target specification for the bucket to create"}},"required":["targetSpec"]},"publicCloud.storage.object.BucketCurrentState":{"type":"object","description":"Current observed state of an S3™ compatible bucket from the S3™ backend","properties":{"encryption":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketEncryptionConfig"}],"description":"Current encryption configuration","nullable":true,"readOnly":true},"location":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketLocation"}],"description":"Geographic region where the bucket is located","readOnly":true},"name":{"type":"string","description":"Bucket name","readOnly":true},"objectLock":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketObjectLockConfig"}],"description":"Current object lock configuration","nullable":true,"readOnly":true},"objectsCount":{"type":"integer","description":"Bucket total objects count. Returned only on a single bucket GET, never on LIST.","nullable":true,"readOnly":true},"objectsSize":{"type":"integer","description":"Bucket total objects size in bytes. Returned only on a single bucket GET, never on LIST.","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Current metadata tags","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"versioning":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketVersioningConfig"}],"description":"Current versioning configuration","nullable":true,"readOnly":true},"virtualHost":{"type":"string","description":"Bucket virtual host, as a hostname without scheme, for example my-data-bucket.s3.gra.io.cloud.ovh.net. Returned only on a single bucket GET, never on LIST.","nullable":true,"readOnly":true}}},"publicCloud.storage.object.BucketEncryptionAlgorithmEnum":{"type":"string","description":"Supported encryption algorithms for S3™ compatible buckets","enum":["AES256","PLAINTEXT"]},"publicCloud.storage.object.BucketEncryptionConfig":{"type":"object","description":"Server-side encryption configuration for an S3™ compatible bucket","properties":{"algorithm":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketEncryptionAlgorithmEnum"}],"description":"Encryption algorithm"}},"required":["algorithm"]},"publicCloud.storage.object.BucketLocation":{"type":"object","description":"Geographic region for an S3™ compatible bucket","properties":{"region":{"type":"string","description":"Region identifier, for example GRA, SBG, BHS"}},"required":["region"]},"publicCloud.storage.object.BucketObjectLockConfig":{"type":"object","description":"Object lock (WORM) configuration for an S3™ compatible bucket. Object lock is armed at bucket creation and cannot be disabled afterward. The default retention rule is optional.","properties":{"mode":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketObjectLockModeEnum"}],"description":"Default retention mode. Requires retentionDays or retentionYears, and status ENABLED. Null when no default retention rule is set.","nullable":true},"retentionDays":{"type":"integer","description":"Number of days the default retention rule locks new objects for. Requires mode, exclusive with retentionYears. Null when no default retention rule is set or when retentionYears is used.","nullable":true},"retentionYears":{"type":"integer","description":"Number of years the default retention rule locks new objects for. Requires mode, exclusive with retentionDays. Null when no default retention rule is set or when retentionDays is used.","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketObjectLockStatusEnum"}],"description":"Whether object lock is armed on the bucket, with or without a default retention rule"}},"required":["status"]},"publicCloud.storage.object.BucketObjectLockModeEnum":{"type":"string","description":"Object lock retention modes","enum":["COMPLIANCE","GOVERNANCE"]},"publicCloud.storage.object.BucketObjectLockStatusEnum":{"type":"string","description":"Object lock status for an S3™ compatible bucket","enum":["DISABLED","ENABLED"]},"publicCloud.storage.object.BucketTargetSpec":{"type":"object","description":"Target specification for an S3™ compatible bucket","properties":{"encryption":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketEncryptionConfig"}],"description":"Server-side encryption configuration","nullable":true},"location":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketLocation"}],"description":"Target geographic region"},"name":{"type":"string","description":"Bucket name (must be globally unique and DNS-compatible)"},"objectLock":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketObjectLockConfig"}],"description":"Object lock (WORM) configuration. Requires versioning to be enabled.","nullable":true},"ownerUserId":{"type":"string","description":"Container owner user ID","nullable":true},"tags":{"type":"object","description":"Metadata tags for the bucket","nullable":true,"additionalProperties":{"type":"string"}},"versioning":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketVersioningConfig"}],"description":"Versioning configuration","nullable":true}},"required":["location","name"]},"publicCloud.storage.object.BucketUpdate":{"type":"object","description":"Payload to update an S3™ compatible bucket","properties":{"checksum":{"type":"string","description":"Optional concurrency-control checksum. When supplied, it must match the resource's current checksum or the request is rejected with a 409 checksum-mismatch conflict. When omitted or empty, the concurrency check is skipped and the write is forced (last-write-wins).","nullable":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketUpdateTargetSpec"}],"description":"Desired target specification for the bucket"}},"required":["targetSpec"]},"publicCloud.storage.object.BucketUpdateTargetSpec":{"type":"object","description":"Target specification for updating an S3™ compatible bucket (mutable fields only)","properties":{"encryption":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketEncryptionConfig"}],"description":"Server-side encryption configuration","nullable":true},"objectLock":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketObjectLockConfig"}],"description":"Object lock (WORM) configuration. Requires versioning to be enabled.","nullable":true},"tags":{"type":"object","description":"Metadata tags for the bucket, replacing the current ones. Omit or send an empty object to remove them all.","nullable":true,"additionalProperties":{"type":"string"}},"versioning":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketVersioningConfig"}],"description":"Versioning configuration","nullable":true}}},"publicCloud.storage.object.BucketVersioningConfig":{"type":"object","description":"Versioning configuration for an S3™ compatible bucket","properties":{"status":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.BucketVersioningStatusEnum"}],"description":"Versioning status"}},"required":["status"]},"publicCloud.storage.object.BucketVersioningStatusEnum":{"type":"string","description":"Versioning status for an S3™ compatible bucket","enum":["DISABLED","ENABLED","SUSPENDED"]},"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":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/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":{"/publicCloud/project/{projectId}/storage/object/bucket":{"get":{"operationId":"getBuckets","summary":"List buckets","description":"Returns the buckets of the project.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.storage.object.Bucket"}}}}}},"tags":["Storage","Object"],"x-developer-hub-navigation":[["Public Cloud","Storage","Object Storage@@@10"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/storage/object/bucket\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/storage/object/bucket\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:bucket/get","required":true}],"x-response-identifier":"id","x-expanded-response":"PublicCloudStorageObjectBucket"},"post":{"operationId":"createBucket","summary":"Create a bucket","description":"Creates a bucket in a region. Versioning, encryption, object lock and tags can be set at creation.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.storage.object.BucketCreation"},"examples":{"Create bucket":{"value":{"targetSpec":{"location":{"region":"GRA"},"name":"my-data-bucket","tags":{"env":"production"},"versioning":{"status":"ENABLED"}}},"summary":"Create a bucket with versioning and tags"}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.storage.object.Bucket"}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::NameAlreadyInUse":{"value":{"class":"Client::Conflict::NameAlreadyInUse","message":"This name is already in use"}},"Client::Conflict::RegionInMaintenance":{"value":{"class":"Client::Conflict::RegionInMaintenance","message":"This region is currently in maintenance"}}}}}}},"tags":["Storage","Object"],"x-developer-hub-navigation":[["Public Cloud","Storage","Object Storage@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#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: publicCloud.storage.object.BucketCreation\nresult = client.post(\"/v2/publicCloud/project/{projectId}/storage/object/bucket\",\n\ttargetSpec = None, # Desired target specification for the bucket to create (type: publicCloud.storage.object.BucketTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.storage.object.BucketCreation\n$result = $ovh->post(\"/v2/publicCloud/project/{projectId}/storage/object/bucket\", array(\n\ttargetSpec => null, // Desired target specification for the bucket to create (type: publicCloud.storage.object.BucketTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:bucket/create","required":true}]}},"/publicCloud/project/{projectId}/storage/object/bucket/{bucketName}":{"delete":{"operationId":"deleteBucket","summary":"Delete a bucket","description":"Deletes the bucket.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bucketName","description":"Bucket name","required":true,"schema":{"type":"string"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.storage.object.Bucket"}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::BucketDoesNotExist":{"value":{"class":"Client::NotFound::BucketDoesNotExist","message":"S3 bucket not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::ResourceAlreadyBeingDeleted":{"value":{"class":"Client::Conflict::ResourceAlreadyBeingDeleted","message":"Resource is already being deleted"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Storage","Object"],"x-developer-hub-navigation":[["Public Cloud","Storage","Object Storage@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-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(\"/v2/publicCloud/project/{projectId}/storage/object/bucket/{bucketName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/v2/publicCloud/project/{projectId}/storage/object/bucket/{bucketName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:bucket/delete","required":true}]},"get":{"operationId":"getBucket","summary":"Get a bucket","description":"Returns the bucket configuration and its current state.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bucketName","description":"Bucket name","required":true,"schema":{"type":"string"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.storage.object.Bucket"},"examples":{"Example":{"value":{"checksum":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","createdAt":"2026-02-01T10:00:00Z","currentState":{"encryption":{"algorithm":"AES256"},"location":{"region":"GRA"},"name":"my-data-bucket","objectsCount":1,"objectsSize":1048576,"tags":{"env":"production"},"versioning":{"status":"ENABLED"},"virtualHost":"my-data-bucket.s3.gra.io.cloud.ovh.net"},"currentTasks":[],"id":"my-data-bucket","resourceStatus":"READY","targetSpec":{"encryption":{"algorithm":"AES256"},"location":{"region":"GRA"},"name":"my-data-bucket","tags":{"env":"production"},"versioning":{"status":"ENABLED"}},"updatedAt":"2026-02-01T10:05:00Z"},"summary":"A bucket with versioning and encryption enabled"}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::BucketDoesNotExist":{"value":{"class":"Client::NotFound::BucketDoesNotExist","message":"S3 bucket not found"}}}}}}},"tags":["Storage","Object"],"x-developer-hub-navigation":[["Public Cloud","Storage","Object Storage@@@35"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/storage/object/bucket/{bucketName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/storage/object/bucket/{bucketName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:bucket/get","required":true}],"x-response-identifier":"id"},"put":{"operationId":"editBucket","summary":"Update a bucket","description":"Updates the bucket configuration. Send the current checksum to prevent overwriting a concurrent change. Without it, the last write wins.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bucketName","description":"Bucket name","required":true,"schema":{"type":"string"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.storage.object.BucketUpdate"},"examples":{"Update bucket":{"value":{"checksum":"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4","targetSpec":{"encryption":{"algorithm":"AES256"},"tags":{"env":"production"},"versioning":{"status":"ENABLED"}}},"summary":"Add encryption to a bucket using optimistic concurrency with checksum"}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.storage.object.Bucket"}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::BucketDoesNotExist":{"value":{"class":"Client::NotFound::BucketDoesNotExist","message":"S3 bucket not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::ChecksumMismatch":{"value":{"class":"Client::Conflict::ChecksumMismatch","message":"Checksum mismatch — a concurrent update was detected. Refresh the resource and retry"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Storage","Object"],"x-developer-hub-navigation":[["Public Cloud","Storage","Object Storage@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#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: publicCloud.storage.object.BucketUpdate\nresult = client.put(\"/v2/publicCloud/project/{projectId}/storage/object/bucket/{bucketName}\",\n\tchecksum = None, # Optional concurrency-control checksum. When supplied, it must match the resource's current checksum or the request is rejected with a 409 checksum-mismatch conflict. When omitted or empty, the concurrency check is skipped and the write is forced (last-write-wins). (type: string, nullable)\n\ttargetSpec = None, # Desired target specification for the bucket (type: publicCloud.storage.object.BucketUpdateTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.storage.object.BucketUpdate\n$result = $ovh->put(\"/v2/publicCloud/project/{projectId}/storage/object/bucket/{bucketName}\", array(\n\tchecksum => null, // Optional concurrency-control checksum. When supplied, it must match the resource's current checksum or the request is rejected with a 409 checksum-mismatch conflict. When omitted or empty, the concurrency check is skipped and the write is forced (last-write-wins). (type: string, nullable)\n\ttargetSpec => null, // Desired target specification for the bucket (type: publicCloud.storage.object.BucketUpdateTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:bucket/edit","required":true}]}}},"tags":[{"name":"Storage","x-tag-expanded":false,"description":"Missing description"},{"name":"Object","x-tag-expanded":false,"description":"Missing description"}]}