{"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 !"},"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.LifecycleRule":{"type":"object","description":"An S3™ compatible bucket lifecycle rule","properties":{"abortIncompleteMultipartUpload":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.LifecycleRuleAbortIncompleteMultipartUpload"}],"description":"Settings for aborting incomplete multipart uploads","nullable":true},"expiration":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.LifecycleRuleExpiration"}],"description":"Expiration settings for current version objects","nullable":true},"filter":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.LifecycleRuleFilter"}],"description":"Filter criteria for the rule","nullable":true},"id":{"type":"string","description":"Unique identifier of the lifecycle rule"},"noncurrentVersionExpiration":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.LifecycleRuleNoncurrentVersionExpiration"}],"description":"Expiration settings for noncurrent version objects","nullable":true},"noncurrentVersionTransitions":{"type":"array","description":"Transition rules for noncurrent version objects","nullable":true,"items":{"$ref":"#/components/schemas/publicCloud.storage.object.LifecycleRuleNoncurrentVersionTransition"}},"status":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.LifecycleRuleStatusEnum"}],"description":"Whether the rule is enabled or disabled"},"transitions":{"type":"array","description":"Transition rules for current version objects","nullable":true,"items":{"$ref":"#/components/schemas/publicCloud.storage.object.LifecycleRuleTransition"}}},"required":["id","status"]},"publicCloud.storage.object.LifecycleRuleAbortIncompleteMultipartUpload":{"type":"object","description":"Settings for aborting incomplete multipart uploads in a lifecycle rule","properties":{"daysAfterInitiation":{"type":"integer","description":"Number of days after initiation to abort incomplete multipart uploads"}},"required":["daysAfterInitiation"]},"publicCloud.storage.object.LifecycleRuleExpiration":{"type":"object","description":"Expiration settings for current object versions in a lifecycle rule","properties":{"date":{"type":"string","description":"Date when objects expire","nullable":true,"format":"date"},"days":{"type":"integer","description":"Number of days after creation when objects expire","nullable":true},"expiredObjectDeleteMarker":{"type":"boolean","description":"Whether to remove expired object delete markers","nullable":true}}},"publicCloud.storage.object.LifecycleRuleFilter":{"type":"object","description":"Filter criteria to select which objects a lifecycle rule applies to","properties":{"objectSizeGreaterThan":{"type":"integer","description":"Minimum object size in bytes for the rule to apply","nullable":true},"objectSizeLessThan":{"type":"integer","description":"Maximum object size in bytes for the rule to apply","nullable":true},"prefix":{"type":"string","description":"Key prefix to filter objects","nullable":true},"tags":{"type":"object","description":"Key-value tag pairs to filter objects","nullable":true,"additionalProperties":{"type":"string"}}}},"publicCloud.storage.object.LifecycleRuleNoncurrentVersionExpiration":{"type":"object","description":"Expiration settings for noncurrent object versions in a lifecycle rule","properties":{"newerNoncurrentVersions":{"type":"integer","description":"Number of newer noncurrent versions to retain","nullable":true},"noncurrentDays":{"type":"integer","description":"Number of days after an object version becomes noncurrent before it expires"}},"required":["noncurrentDays"]},"publicCloud.storage.object.LifecycleRuleNoncurrentVersionTransition":{"type":"object","description":"Storage class transition for noncurrent object versions","properties":{"newerNoncurrentVersions":{"type":"integer","description":"Number of newer noncurrent versions to retain before transitioning","nullable":true},"noncurrentDays":{"type":"integer","description":"Number of days after an object version becomes noncurrent before it transitions"},"storageClass":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.StorageClassLifecycleEnum"}],"description":"Target storage class for the transition"}},"required":["noncurrentDays","storageClass"]},"publicCloud.storage.object.LifecycleRulePut":{"type":"object","description":"Payload to replace all lifecycle rules for an S3™ compatible bucket","properties":{"rules":{"type":"array","description":"Array of lifecycle rules. An empty array deletes all rules.","items":{"$ref":"#/components/schemas/publicCloud.storage.object.LifecycleRule"}}},"required":["rules"]},"publicCloud.storage.object.LifecycleRuleStatusEnum":{"type":"string","description":"Possible statuses for an S3™ compatible bucket lifecycle rule","enum":["DISABLED","ENABLED"]},"publicCloud.storage.object.LifecycleRuleTransition":{"type":"object","description":"Storage class transition for current object versions","properties":{"date":{"type":"string","description":"Date (YYYY-MM-DD) when objects transition to another storage class","nullable":true,"format":"date"},"days":{"type":"integer","description":"Number of days after creation when objects transition","nullable":true},"storageClass":{"allOf":[{"$ref":"#/components/schemas/publicCloud.storage.object.StorageClassLifecycleEnum"}],"description":"Target storage class for the transition"}},"required":["storageClass"]},"publicCloud.storage.object.LifecycleRulesResponse":{"type":"object","description":"Response containing lifecycle rules for an S3™ compatible bucket","properties":{"rules":{"type":"array","description":"Array of lifecycle rules","items":{"$ref":"#/components/schemas/publicCloud.storage.object.LifecycleRule"},"readOnly":true}}},"publicCloud.storage.object.StorageClassLifecycleEnum":{"type":"string","description":"Available S3™ storage classes for lifecycle rules","enum":["DEEP_ARCHIVE","GLACIER_IR","STANDARD","STANDARD_IA"]},"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/{bucketName}/lifecycle":{"get":{"operationId":"getBucketLifecycle","summary":"List lifecycle rules","description":"Returns the rules that expire objects or move them to another storage class.","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.LifecycleRulesResponse"}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"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","Lifecycle Management@@@10"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-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}/lifecycle\")\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}/lifecycle\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:storage/object/bucket/lifecycle/get","required":true}]},"put":{"operationId":"editBucketLifecycle","summary":"Replace lifecycle rules","description":"Replaces all lifecycle rules of the bucket. An empty list deletes all rules.","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.LifecycleRulePut"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.storage.object.LifecycleRulesResponse"}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"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","Lifecycle Management@@@20"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#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.LifecycleRulePut\nresult = client.put(\"/v2/publicCloud/project/{projectId}/storage/object/bucket/{bucketName}/lifecycle\",\n\trules = None, # Array of lifecycle rules. An empty array deletes all rules. (type: array)\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.LifecycleRulePut\n$result = $ovh->put(\"/v2/publicCloud/project/{projectId}/storage/object/bucket/{bucketName}/lifecycle\", array(\n\trules => null, // Array of lifecycle rules. An empty array deletes all rules. (type: array)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:storage/object/bucket/lifecycle/edit","required":true}]}}},"tags":[{"name":"Storage","x-tag-expanded":false,"description":"Missing description"},{"name":"Object","x-tag-expanded":false,"description":"Missing description"}]}