{"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}}},"dedicated.server":{"type":"object","description":"Dedicated server resource","properties":{"checksum":{"type":"string","description":"Checksum of the target spec (mutable params). Send it back on update. Rejected if another caller changed the target since your read.","readOnly":true},"currentState":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.CurrentState"}],"description":"State observed on the server","readOnly":true},"currentTasks":{"type":"array","description":"Asynchronous operations currently running. Omitted, never null, when no update is running, and always omitted from the server list.","nullable":true,"items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"id":{"type":"string","description":"Service name of the dedicated server resource","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Reflects the readiness of the dedicated server resource. A new target specification request will be accepted only in `READY` status.","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.TargetSpec"}],"description":"Target specification last declared on the server","readOnly":true}}},"dedicated.server.ActionEnum":{"type":"string","description":"Action a dedicated server resource can be asked to perform","enum":["ENABLE_ENCRYPTION_AT_REST"]},"dedicated.server.ActionReason":{"type":"object","description":"Reason that blocks an action","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.ActionReasonCodeEnum"}],"description":"Reason that blocks the action","readOnly":true},"details":{"type":"object","description":"Subjects the reason names, such as operationId for EXCLUSIVE_OPERATION_RUNNING. Null when the reason names none.","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"nature":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.ActionReasonNatureEnum"}],"description":"Whether the reason can clear by itself (TRANSIENT) or not (PERMANENT)","readOnly":true}}},"dedicated.server.ActionReasonCodeEnum":{"type":"string","description":"Reason that blocks an action","enum":["EXCLUSIVE_OPERATION_RUNNING","NOT_ELIGIBLE"]},"dedicated.server.ActionReasonNatureEnum":{"type":"string","description":"Whether a reason that blocks an action can clear by itself","enum":["PERMANENT","TRANSIENT"]},"dedicated.server.ActionStatusEnum":{"type":"string","description":"Whether the server accepts an action. UNDETERMINED means nothing known blocks the action but a condition could not be checked.","enum":["AVAILABLE","UNAVAILABLE","UNDETERMINED"]},"dedicated.server.AvailableAction":{"type":"object","description":"Whether the server accepts one action, and why it does not","properties":{"action":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.ActionEnum"}],"description":"Action whose availability this entry reports","readOnly":true},"blockedBy":{"type":"array","description":"All reasons that make the action unavailable. Null unless status is UNAVAILABLE.","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.ActionReason"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.ActionStatusEnum"}],"description":"Whether the server accepts the action now","readOnly":true}}},"dedicated.server.CurrentState":{"type":"object","description":"Current state of the dedicated server resource","properties":{"actions":{"type":"array","description":"Availability of each action the server can be asked to perform. Present only when the read asks for it with actions=true. Absence means it was not asked for.","nullable":true,"items":{"$ref":"#/components/schemas/dedicated.server.AvailableAction"},"readOnly":true},"features":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.Features"}],"description":"Features observed on the server","readOnly":true}}},"dedicated.server.FeatureEncryptionAtRest":{"type":"object","description":"Encryption of the data at rest on the server disks","properties":{"enabled":{"type":"boolean","description":"Whether the data at rest on the server disks is encrypted","readOnly":true}}},"dedicated.server.Features":{"type":"object","description":"Features of the dedicated server resource","properties":{"encryptionAtRest":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.FeatureEncryptionAtRest"}],"description":"Encryption of the data at rest on the server disks. Reported on every server, with `enabled` false when the encryption is not in force.","readOnly":true}}},"dedicated.server.TargetSpec":{"type":"object","description":"Target specification of the dedicated server resource","properties":{"features":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.TargetSpecFeatures"}],"description":"Desired state of every feature of the server"}},"required":["features"]},"dedicated.server.TargetSpecFeatureEncryptionAtRest":{"type":"object","description":"Desired encryption of the data at rest on the server disks","properties":{"enabled":{"type":"boolean","description":"Whether the data at rest on the server disks must be encrypted"}},"required":["enabled"]},"dedicated.server.TargetSpecFeatures":{"type":"object","description":"Desired feature state of the dedicated server resource","properties":{"encryptionAtRest":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.TargetSpecFeatureEncryptionAtRest"}],"description":"Desired encryption of the data at rest on the server disks"}},"required":["encryptionAtRest"]},"dedicated.serverWithIAM":{"type":"object","description":"Dedicated server resource","properties":{"checksum":{"type":"string","description":"Checksum of the target spec (mutable params). Send it back on update. Rejected if another caller changed the target since your read.","readOnly":true},"currentState":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.CurrentState"}],"description":"State observed on the server","readOnly":true},"currentTasks":{"type":"array","description":"Asynchronous operations currently running. Omitted, never null, when no update is running, and always omitted from the server list.","nullable":true,"items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"id":{"type":"string","description":"Service name of the dedicated server resource","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Reflects the readiness of the dedicated server resource. A new target specification request will be accepted only in `READY` status.","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/dedicated.server.TargetSpec"}],"description":"Target specification last declared on the server","readOnly":true}}},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value. Defaults to `EQ`.","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"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"},"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":{"/dedicated/server":{"get":{"operationId":"getAllDedicatedServers","summary":"List dedicated server resources","description":"Get the list of all my dedicated server resources.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/dedicated.serverWithIAM"}}}}},"500":{"description":"Error 500 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Server::InternalServerError::ResourceReferentialDesync":{"value":{"class":"Server::InternalServerError::ResourceReferentialDesync","message":"The dedicated server resource could not be read because of an internal inconsistency"}}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@10"]],"x-badges":[{"color":"blue","label":"Beta version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/dedicated/server\")\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/dedicated/server\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:get","required":true}],"x-expanded-response":"DedicatedServerWithIAM"}},"/dedicated/server/{serviceName}":{"get":{"operationId":"getDedicatedServer","summary":"Get dedicated server resource","description":"Get the details of the dedicated server resource.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"actions","description":"Also report, under currentState.actions, whether the server accepts each action it can be asked to perform","schema":{"type":"boolean"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dedicated.serverWithIAM"}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::DedicatedServer":{"value":{"class":"Client::NotFound::DedicatedServer","message":"Dedicated server resource {{.id}} not found"}},"Client::NotFound::DedicatedServerMultiple":{"value":{"class":"Client::NotFound::DedicatedServerMultiple","message":"At least one of the dedicated server resource(s) requested was not found"}}}}}},"500":{"description":"Error 500 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Server::InternalServerError::ResourceReferentialDesync":{"value":{"class":"Server::InternalServerError::ResourceReferentialDesync","message":"The dedicated server resource could not be read because of an internal inconsistency"}}}}}}},"x-developer-hub-navigation":[["Bare Metal Cloud","Dedicated Servers","Server@@@20"]],"x-badges":[{"color":"blue","label":"Beta version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/dedicated/server/{serviceName}\")\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/dedicated/server/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"dedicatedServer:apiovh:get","required":true}]}}}}