{"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.common.Location":{"type":"object","description":"Resource location","properties":{"availabilityZone":{"type":"string","description":"Availability zone within the region","nullable":true},"region":{"type":"string","description":"Region code"}},"required":["region"]},"publicCloud.securityGroup.EthernetTypeEnum":{"type":"string","description":"Ethernet type for a security group rule","enum":["IPV4","IPV6"]},"publicCloud.securityGroup.ProtocolEnum":{"type":"string","description":"Network protocol for a security group rule","enum":["AH","DCCP","EGP","ESP","GRE","ICMP","ICMPV6","IGMP","OSPF","PGM","RSVP","SCTP","TCP","UDP","UDPLITE","VRRP"]},"publicCloud.securityGroup.SecurityGroup":{"type":"object","description":"A Public Cloud security group","properties":{"checksum":{"type":"string","description":"Computed hash representing the current target specification value","readOnly":true},"createdAt":{"type":"string","description":"Creation date of the security group","format":"date-time","readOnly":true},"currentState":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroupCurrentState"}],"description":"Current state of the security group","nullable":true,"readOnly":true},"currentTasks":{"type":"array","description":"Ongoing asynchronous tasks related to the security group","nullable":true,"items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"id":{"type":"string","description":"Unique identifier of the security group","format":"uuid","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Security group readiness in the system","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroupTargetSpec"}],"description":"Last target specification of the security group","readOnly":true},"updatedAt":{"type":"string","description":"Last update date of the security group","format":"date-time","readOnly":true}}},"publicCloud.securityGroup.SecurityGroupCreation":{"type":"object","description":"Payload to create a Public Cloud security group","properties":{"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroupTargetSpec"}],"description":"Desired target specification for the security group to create"}},"required":["targetSpec"]},"publicCloud.securityGroup.SecurityGroupCurrentState":{"type":"object","description":"Current state of a security group from OpenStack","properties":{"defaultRules":{"type":"array","description":"Default egress rules auto-created by OpenStack","nullable":true,"items":{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroupStateRule"},"readOnly":true},"description":{"type":"string","description":"Security group description","nullable":true,"readOnly":true},"location":{"allOf":[{"$ref":"#/components/schemas/publicCloud.common.Location"}],"description":"Geographic location","readOnly":true},"name":{"type":"string","description":"Security group name","readOnly":true},"rules":{"type":"array","description":"User-specified firewall rules","nullable":true,"items":{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroupStateRule"},"readOnly":true}}},"publicCloud.securityGroup.SecurityGroupRef":{"type":"object","description":"Reference to a security group","properties":{"id":{"type":"string","description":"Identifier of the security group","format":"uuid"}},"required":["id"]},"publicCloud.securityGroup.SecurityGroupStateRule":{"type":"object","description":"Actual firewall rule from OpenStack for a security group","properties":{"description":{"type":"string","description":"Rule description","nullable":true,"readOnly":true},"direction":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.TrafficFlowEnum"}],"description":"Traffic flow","readOnly":true},"ethernetType":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.EthernetTypeEnum"}],"description":"IP version the rule applies to. A rule written for IPv4 does not affect IPv6 traffic, and the other way round.","readOnly":true},"id":{"type":"string","description":"Rule identifier from OpenStack","format":"uuid","readOnly":true},"portRangeMax":{"type":"integer","description":"Maximum port number","nullable":true,"readOnly":true},"portRangeMin":{"type":"integer","description":"Minimum port number","nullable":true,"readOnly":true},"protocol":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.ProtocolEnum"}],"description":"Network protocol","nullable":true,"readOnly":true},"remoteGroup":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroupRef"}],"description":"Reference to remote security group","nullable":true,"readOnly":true},"remoteIpPrefix":{"allOf":[{"$ref":"#/components/schemas/ipBlock"}],"description":"Remote CIDR prefix","nullable":true,"readOnly":true}}},"publicCloud.securityGroup.SecurityGroupTargetRule":{"type":"object","description":"Desired firewall rule for a security group","properties":{"description":{"type":"string","description":"Rule description","nullable":true},"direction":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.TrafficFlowEnum"}],"description":"Traffic flow"},"ethernetType":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.EthernetTypeEnum"}],"description":"IP version the rule applies to. A rule written for IPv4 does not affect IPv6 traffic, and the other way round."},"portRangeMax":{"type":"integer","description":"Maximum port number","nullable":true},"portRangeMin":{"type":"integer","description":"Minimum port number","nullable":true},"protocol":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.ProtocolEnum"}],"description":"Network protocol","nullable":true},"remoteGroup":{"allOf":[{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroupRef"}],"description":"Reference to remote security group (mutually exclusive with remoteIpPrefix)","nullable":true},"remoteIpPrefix":{"allOf":[{"$ref":"#/components/schemas/ipBlock"}],"description":"Remote CIDR prefix (mutually exclusive with remoteGroup)","nullable":true}},"required":["direction","ethernetType"]},"publicCloud.securityGroup.SecurityGroupTargetSpec":{"type":"object","description":"Desired specification for creating a security group","properties":{"description":{"type":"string","description":"Security group description","nullable":true},"location":{"allOf":[{"$ref":"#/components/schemas/publicCloud.common.Location"}],"description":"Geographic location"},"name":{"type":"string","description":"Security group name"},"rules":{"type":"array","description":"Desired firewall rules","nullable":true,"items":{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroupTargetRule"}}},"required":["location","name"]},"publicCloud.securityGroup.SecurityGroupUpdate":{"type":"object","description":"Payload to update a Public Cloud security group","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.securityGroup.SecurityGroupUpdateTargetSpec"}],"description":"Desired target specification for the security group"}},"required":["targetSpec"]},"publicCloud.securityGroup.SecurityGroupUpdateTargetSpec":{"type":"object","description":"Desired specification for updating a security group (mutable fields only)","properties":{"description":{"type":"string","description":"Security group description","nullable":true},"name":{"type":"string","description":"Security group name"},"rules":{"type":"array","description":"Desired firewall rules","nullable":true,"items":{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroupTargetRule"}}},"required":["name"]},"publicCloud.securityGroup.TrafficFlowEnum":{"type":"string","description":"Flow rule of traffic for a security group rule","enum":["EGRESS","INGRESS"]},"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}/securityGroup":{"get":{"operationId":"getSecurityGroups","summary":"List security groups","description":"Returns the security groups 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.securityGroup.SecurityGroup"}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Security Groups@@@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}/securityGroup\")\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}/securityGroup\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:securityGroup/get","required":true}],"x-response-identifier":"id","x-expanded-response":"PublicCloudSecurityGroupSecurityGroup"},"post":{"operationId":"createSecurityGroup","summary":"Create a security group","description":"Creates a security group with inline rules. OpenStack adds default egress rules automatically.","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.securityGroup.SecurityGroupCreation"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroup"}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"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":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Security Groups@@@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.securityGroup.SecurityGroupCreation\nresult = client.post(\"/v2/publicCloud/project/{projectId}/securityGroup\",\n\ttargetSpec = None, # Desired target specification for the security group to create (type: publicCloud.securityGroup.SecurityGroupTargetSpec)\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.securityGroup.SecurityGroupCreation\n$result = $ovh->post(\"/v2/publicCloud/project/{projectId}/securityGroup\", array(\n\ttargetSpec => null, // Desired target specification for the security group to create (type: publicCloud.securityGroup.SecurityGroupTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:securityGroup/create","required":true}]}},"/publicCloud/project/{projectId}/securityGroup/{securityGroupId}":{"delete":{"operationId":"deleteSecurityGroup","summary":"Delete a security group","description":"Deletes the security group. Deletion is not blocked for a group still attached to interfaces or the project's default group.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"securityGroupId","description":"Security group ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroup"}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::SecurityGroupDoesNotExist":{"value":{"class":"Client::NotFound::SecurityGroupDoesNotExist","message":"Security group 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":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Security Groups@@@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\nresult = client.delete(\"/v2/publicCloud/project/{projectId}/securityGroup/{securityGroupId}\")\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}/securityGroup/{securityGroupId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:securityGroup/delete","required":true}]},"get":{"operationId":"getSecurityGroup","summary":"Get a security group","description":"Returns the security group, including its rules and default egress rules.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"securityGroupId","description":"Security group ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroup"}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::SecurityGroupDoesNotExist":{"value":{"class":"Client::NotFound::SecurityGroupDoesNotExist","message":"Security group not found"}}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Security Groups@@@20"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-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}/securityGroup/{securityGroupId}\")\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}/securityGroup/{securityGroupId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:securityGroup/get","required":true}],"x-response-identifier":"id"},"put":{"operationId":"editSecurityGroup","summary":"Update a security group","description":"Replaces the security group's name, description and rules as a whole.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}},{"in":"path","name":"securityGroupId","description":"Security group ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroupUpdate"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.securityGroup.SecurityGroup"}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::SecurityGroupDoesNotExist":{"value":{"class":"Client::NotFound::SecurityGroupDoesNotExist","message":"Security group 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":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Security Groups@@@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\n# Request body type: publicCloud.securityGroup.SecurityGroupUpdate\nresult = client.put(\"/v2/publicCloud/project/{projectId}/securityGroup/{securityGroupId}\",\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 security group (type: publicCloud.securityGroup.SecurityGroupUpdateTargetSpec)\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.securityGroup.SecurityGroupUpdate\n$result = $ovh->put(\"/v2/publicCloud/project/{projectId}/securityGroup/{securityGroupId}\", 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 security group (type: publicCloud.securityGroup.SecurityGroupUpdateTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:securityGroup/edit","required":true}]}}},"tags":[{"name":"Network","x-tag-expanded":false,"description":"Missing description"}]}