{"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/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"audit.Log":{"type":"object","description":"An audit Log","properties":{"authDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogAuthDetails"}],"description":"authentication details","nullable":true,"readOnly":true},"createdAt":{"type":"string","description":"event's date","format":"date-time","readOnly":true},"groupCreatedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogGroupCreatedDetails"}],"description":"specific fields for GROUP_CREATED events","nullable":true,"readOnly":true},"groupDeletedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogGroupDeletedDetails"}],"description":"specific fields for GROUP_DELETED events","nullable":true,"readOnly":true},"groupModifiedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogGroupModifiedDetails"}],"description":"specific fields for GROUP_MODIFIED events","nullable":true,"readOnly":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"IP associated to this event","nullable":true,"readOnly":true},"loginSuccessDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogLoginSuccessDetails"}],"description":"specific fields for LOGIN_SUCCESS events","nullable":true,"readOnly":true},"policyCreatedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyCreatedDetails"}],"description":"specific fields for POLICY_CREATED events","nullable":true,"readOnly":true},"policyDeletedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyDeletedDetails"}],"description":"specific fields for POLICY_DELETED events","nullable":true,"readOnly":true},"policyModifiedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyModifiedDetails"}],"description":"specific fields for POLICY_MODIFIED events","nullable":true,"readOnly":true},"providerCreatedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogProviderCreatedDetails"}],"description":"specific fields for PROVIDER_CREATED events","nullable":true,"readOnly":true},"providerDeletedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogProviderDeletedDetails"}],"description":"specific fields for PROVIDER_DELETED events","nullable":true,"readOnly":true},"providerModifiedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogProviderModifiedDetails"}],"description":"specific fields for PROVIDER_MODIFIED events","nullable":true,"readOnly":true},"resourceGroupCreatedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupCreatedDetails"}],"description":"specific fields for RESOURCE_GROUP_CREATED events","nullable":true,"readOnly":true},"resourceGroupDeletedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupDeletedDetails"}],"description":"specific fields for RESOURCE_GROUP_DELETED events","nullable":true,"readOnly":true},"resourceGroupModifiedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupModifiedDetails"}],"description":"specific fields for RESOURCE_GROUP_MODIFIED events","nullable":true,"readOnly":true},"tokenCreatedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogTokenCreatedDetails"}],"description":"specific fields for TOKEN_CREATED events","nullable":true,"readOnly":true},"tokenDeletedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogTokenDeletedDetails"}],"description":"specific fields for TOKEN_DELETED events","nullable":true,"readOnly":true},"tokenModifiedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogTokenModifiedDetails"}],"description":"specific fields for TOKEN_MODIFIED events","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/audit.LogTypeEnum"}],"description":"type of event","readOnly":true},"userCreatedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogUserCreatedDetails"}],"description":"specific fields for USER_CREATED events","nullable":true,"readOnly":true},"userDeletedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogUserDeletedDetails"}],"description":"specific fields for USER_DELETED events","nullable":true,"readOnly":true},"userModifiedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogUserModifiedDetails"}],"description":"specific fields for USER_MODIFIED events","nullable":true,"readOnly":true},"userPasswordChangedDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogUserPasswordChangedDetails"}],"description":"specific fields for USER_PASSWORD_CHANGED events","nullable":true,"readOnly":true}}},"audit.LogAuthDetails":{"type":"object","description":"Authentication details","properties":{"userDetails":{"allOf":[{"$ref":"#/components/schemas/audit.LogAuthUserDetails"}],"description":"authenticated user details","readOnly":true}}},"audit.LogAuthMFATypeEnum":{"type":"string","description":"Authentication MFA type","enum":["BACKUP_CODE","MAIL","NONE","SMS","TOTP","U2F","UNKNOWN"]},"audit.LogAuthUserDetails":{"type":"object","description":"Authenticated user details","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/audit.LogAuthUserTypeEnum"}],"description":"authentication type","readOnly":true},"user":{"type":"string","description":"authenticated user name","nullable":true,"readOnly":true}}},"audit.LogAuthUserTypeEnum":{"type":"string","description":"Authentication type","enum":["ACCOUNT","PROVIDER","USER"]},"audit.LogGroupCreatedDetails":{"type":"object","description":"specific fields for GROUP_CREATED events","properties":{"group":{"type":"string","description":"Identifier of the group","readOnly":true},"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogGroupDetails"}],"description":"Group details after creation","nullable":true,"readOnly":true}}},"audit.LogGroupDeletedDetails":{"type":"object","description":"specific fields for GROUP_DELETED events","properties":{"group":{"type":"string","description":"Identifier of the group","readOnly":true},"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogGroupDetails"}],"description":"Group details before deletion","nullable":true,"readOnly":true}}},"audit.LogGroupDetails":{"type":"object","description":"Specific fields for GROUP events","properties":{"description":{"type":"string","description":"Description of the group","nullable":true,"readOnly":true},"name":{"type":"string","description":"Name of the group","readOnly":true},"role":{"type":"string","description":"Role of the group","readOnly":true}}},"audit.LogGroupModifiedDetails":{"type":"object","description":"specific fields for GROUP_MODIFIED events","properties":{"group":{"type":"string","description":"Identifier of the group","readOnly":true},"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogGroupDetails"}],"description":"Group details after update","nullable":true,"readOnly":true},"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogGroupDetails"}],"description":"Group details before update","nullable":true,"readOnly":true}}},"audit.LogLoginSuccessDetails":{"type":"object","description":"specific fields for LOGIN_SUCCESS events","properties":{"mfaType":{"allOf":[{"$ref":"#/components/schemas/audit.LogAuthMFATypeEnum"}],"description":"Used MFA while login","nullable":true,"readOnly":true},"userAgent":{"type":"string","description":"Browser's user agent","readOnly":true}}},"audit.LogPolicyChanges":{"type":"object","description":"Changed fields for POLICY events","properties":{"identities":{"type":"array","description":"Identities changed on the policy","nullable":true,"items":{"type":"string"},"readOnly":true},"resources":{"type":"array","description":"Resources changed on the policy","nullable":true,"items":{"type":"string"},"readOnly":true}}},"audit.LogPolicyCreatedDetails":{"type":"object","description":"specific fields for POLICY_CREATED events","properties":{"added":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyChanges"}],"description":"Policy changes","nullable":true,"readOnly":true},"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyDetails"}],"description":"Policy details after creation","nullable":true,"readOnly":true},"policyId":{"type":"string","description":"Id of the policy","format":"uuid","readOnly":true},"policyName":{"type":"string","description":"Name of the policy","readOnly":true}}},"audit.LogPolicyDeletedDetails":{"type":"object","description":"specific fields for POLICY_DELETED events","properties":{"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyDetails"}],"description":"Policy details before deletion","nullable":true,"readOnly":true},"policyId":{"type":"string","description":"Id of the policy","format":"uuid","readOnly":true},"policyName":{"type":"string","description":"Name of the policy","readOnly":true},"removed":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyChanges"}],"description":"Policy changes","nullable":true,"readOnly":true}}},"audit.LogPolicyDetails":{"type":"object","description":"Specific fields for POLICY events","properties":{"description":{"type":"string","description":"Description of the policy","readOnly":true},"name":{"type":"string","description":"Name of the policy","readOnly":true}}},"audit.LogPolicyModifiedDetails":{"type":"object","description":"specific fields for POLICY_MODIFIED events","properties":{"added":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyChanges"}],"description":"Policy changes (addition)","nullable":true,"readOnly":true},"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyDetails"}],"description":"Policy details after update","nullable":true,"readOnly":true},"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyDetails"}],"description":"Policy details before update","nullable":true,"readOnly":true},"policyId":{"type":"string","description":"Id of the policy","format":"uuid","readOnly":true},"policyName":{"type":"string","description":"Name of the policy","readOnly":true},"removed":{"allOf":[{"$ref":"#/components/schemas/audit.LogPolicyChanges"}],"description":"Policy changes (removal)","nullable":true,"readOnly":true}}},"audit.LogProviderCreatedDetails":{"type":"object","description":"specific fields for PROVIDER_CREATED events","properties":{"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogProviderDetails"}],"description":"Provider details after creation","nullable":true,"readOnly":true},"ssoServiceURL":{"type":"string","description":"SSO URL of the provider","readOnly":true}}},"audit.LogProviderDeletedDetails":{"type":"object","description":"specific fields for PROVIDER_DELETED events","properties":{"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogProviderDetails"}],"description":"Provider details before deletion","nullable":true,"readOnly":true},"ssoServiceURL":{"type":"string","description":"SSO URL of the provider","readOnly":true}}},"audit.LogProviderDetails":{"type":"object","description":"specific fields for PROVIDER events","properties":{"groupAttributeName":{"type":"string","description":"SAML group attribute name of the provider","readOnly":true},"requestSignatureEnabled":{"type":"boolean","description":"SAML request signature enabled","readOnly":true},"userAttributeName":{"type":"string","description":"SAML user attribute name of the provider","readOnly":true},"usersDisabled":{"type":"boolean","description":"Provider use disabled account users","readOnly":true}}},"audit.LogProviderModifiedDetails":{"type":"object","description":"specific fields for PROVIDER_MODIFIED events","properties":{"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogProviderDetails"}],"description":"Provider details after update","nullable":true,"readOnly":true},"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogProviderDetails"}],"description":"Provider details before update","nullable":true,"readOnly":true},"ssoServiceURL":{"type":"string","description":"SSO URL of the provider","readOnly":true}}},"audit.LogResourceGroupChanges":{"type":"object","description":"Changed fields for RESOURCE_GROUP events","properties":{"resources":{"type":"array","description":"Resources changed on the resource group","nullable":true,"items":{"type":"string"},"readOnly":true}}},"audit.LogResourceGroupCreatedDetails":{"type":"object","description":"specific fields for RESOURCE_GROUP_CREATED events","properties":{"added":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupChanges"}],"description":"Resource group changes","nullable":true,"readOnly":true},"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupDetails"}],"description":"Resource group details after creation","nullable":true,"readOnly":true},"resourceGroupId":{"type":"string","description":"Id of the resource group","format":"uuid","readOnly":true},"resourceGroupName":{"type":"string","description":"Name of the resource group","readOnly":true}}},"audit.LogResourceGroupDeletedDetails":{"type":"object","description":"specific fields for RESOURCE_GROUP_DELETED events","properties":{"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupDetails"}],"description":"Resource group details before deletion","nullable":true,"readOnly":true},"removed":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupChanges"}],"description":"Resource group changes","nullable":true,"readOnly":true},"resourceGroupId":{"type":"string","description":"Id of the resource group","format":"uuid","readOnly":true},"resourceGroupName":{"type":"string","description":"Name of the resource group","readOnly":true}}},"audit.LogResourceGroupDetails":{"type":"object","description":"Specific fields for RESOURCE_GROUP events","properties":{"name":{"type":"string","description":"Name of the policy","readOnly":true}}},"audit.LogResourceGroupModifiedDetails":{"type":"object","description":"specific fields for RESOURCE_GROUP_MODIFIED events","properties":{"added":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupChanges"}],"description":"Resource group changes (addition)","nullable":true,"readOnly":true},"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupDetails"}],"description":"Resource group details after update","nullable":true,"readOnly":true},"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupDetails"}],"description":"Resource group details before update","nullable":true,"readOnly":true},"removed":{"allOf":[{"$ref":"#/components/schemas/audit.LogResourceGroupChanges"}],"description":"Resource group changes (removal)","nullable":true,"readOnly":true},"resourceGroupId":{"type":"string","description":"Id of the resource group","format":"uuid","readOnly":true},"resourceGroupName":{"type":"string","description":"Name of the resource group","readOnly":true}}},"audit.LogTokenCreatedDetails":{"type":"object","description":"specific fields for TOKEN_CREATED events","properties":{"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogTokenDetails"}],"description":"Token details after creation","nullable":true,"readOnly":true},"tokenCreatedAt":{"type":"string","description":"Token's creation date","nullable":true,"format":"date-time","readOnly":true},"tokenName":{"type":"string","description":"Name of the token","readOnly":true},"user":{"type":"string","description":"Login of the user","readOnly":true}}},"audit.LogTokenDeletedDetails":{"type":"object","description":"specific fields for TOKEN_DELETED events","properties":{"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogTokenDetails"}],"description":"Token details before deletion","nullable":true,"readOnly":true},"tokenCreatedAt":{"type":"string","description":"Token's creation date","nullable":true,"format":"date-time","readOnly":true},"tokenName":{"type":"string","description":"Name of the token","readOnly":true},"user":{"type":"string","description":"Login of the user","readOnly":true}}},"audit.LogTokenDetails":{"type":"object","description":"specific fields for TOKEN events","properties":{"description":{"type":"string","description":"Description of the token","readOnly":true},"expiresAt":{"type":"string","description":"Token's expiration date","nullable":true,"format":"date-time","readOnly":true}}},"audit.LogTokenModifiedDetails":{"type":"object","description":"specific fields for TOKEN_MODIFIED events","properties":{"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogTokenDetails"}],"description":"Token details after update","nullable":true,"readOnly":true},"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogTokenDetails"}],"description":"Token details before update","nullable":true,"readOnly":true},"tokenCreatedAt":{"type":"string","description":"Token's creation date","nullable":true,"format":"date-time","readOnly":true},"tokenName":{"type":"string","description":"Name of the token","readOnly":true},"user":{"type":"string","description":"Login of the user","readOnly":true}}},"audit.LogTypeEnum":{"type":"string","description":"Audit event type","enum":["ACCOUNT_PASSWORD_CHANGED","GROUP_CREATED","GROUP_DELETED","GROUP_MODIFIED","LOGIN_SUCCESS","POLICY_CREATED","POLICY_DELETED","POLICY_MODIFIED","PROVIDER_CREATED","PROVIDER_DELETED","PROVIDER_MODIFIED","RESOURCE_GROUP_CREATED","RESOURCE_GROUP_DELETED","RESOURCE_GROUP_MODIFIED","TOKEN_CREATED","TOKEN_DELETED","TOKEN_MODIFIED","USER_CREATED","USER_DELETED","USER_MODIFIED","USER_PASSWORD_CHANGED"]},"audit.LogUserCreatedDetails":{"type":"object","description":"specific fields for USER_CREATED events","properties":{"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogUserDetails"}],"description":"User details after creation","nullable":true,"readOnly":true},"user":{"type":"string","description":"Login of the user","readOnly":true},"userCreatedAt":{"type":"string","description":"User's creation date","nullable":true,"format":"date-time","readOnly":true},"userType":{"allOf":[{"$ref":"#/components/schemas/auth.UserTypeEnum"}],"description":"Type of user created","nullable":true,"readOnly":true}}},"audit.LogUserDeletedDetails":{"type":"object","description":"specific fields for USER_DELETED events","properties":{"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogUserDetails"}],"description":"User details before deletion","nullable":true,"readOnly":true},"user":{"type":"string","description":"Login of the user","readOnly":true},"userCreatedAt":{"type":"string","description":"User's creation date","nullable":true,"format":"date-time","readOnly":true},"userType":{"allOf":[{"$ref":"#/components/schemas/auth.UserTypeEnum"}],"description":"Type of user created","nullable":true,"readOnly":true}}},"audit.LogUserDetails":{"type":"object","description":"specific fields for USER events","properties":{"description":{"type":"string","description":"Description of the user","readOnly":true},"group":{"type":"string","description":"Group of the user","readOnly":true},"passwordRecoveryEmail":{"type":"string","description":"Email of the user","nullable":true,"readOnly":true},"userType":{"allOf":[{"$ref":"#/components/schemas/auth.UserTypeEnum"}],"description":"Type of user created","nullable":true,"readOnly":true}}},"audit.LogUserModifiedDetails":{"type":"object","description":"specific fields for USER_MODIFIED events","properties":{"new":{"allOf":[{"$ref":"#/components/schemas/audit.LogUserDetails"}],"description":"User details after update","nullable":true,"readOnly":true},"old":{"allOf":[{"$ref":"#/components/schemas/audit.LogUserDetails"}],"description":"User details before update","nullable":true,"readOnly":true},"user":{"type":"string","description":"Login of the user","readOnly":true},"userCreatedAt":{"type":"string","description":"User's creation date","nullable":true,"format":"date-time","readOnly":true}}},"audit.LogUserPasswordChangedDetails":{"type":"object","description":"specific fields for USER_PASSWORD_CHANGED events","properties":{"user":{"type":"string","description":"User name","readOnly":true},"userCreatedAt":{"type":"string","description":"User's creation date","nullable":true,"format":"date-time","readOnly":true}}},"auth.UserTypeEnum":{"type":"string","description":"Type of user","enum":["ROOT","SERVICE","USER"]},"dbaas.logs.LogKind":{"type":"object","description":"Log kind","properties":{"additionalReturnedFields":{"type":"array","description":"List of additional log fields managed in this log kind","items":{"type":"string"},"readOnly":true},"createdAt":{"type":"string","description":"Creation date of the log kind","format":"date-time","readOnly":true},"displayName":{"type":"string","description":"Log kind display name","readOnly":true},"kindId":{"type":"string","description":"Log kind ID","format":"uuid","readOnly":true},"name":{"type":"string","description":"Log kind name","readOnly":true},"updatedAt":{"type":"string","description":"Last update date of the log kind","format":"date-time","readOnly":true}}},"dbaas.logs.LogSubscription":{"type":"object","description":"Log subscription","properties":{"createdAt":{"type":"string","description":"Creation date of the subscription","format":"date-time","readOnly":true},"kind":{"type":"string","description":"Log kind name of this subscription","readOnly":true},"resource":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.SubscriptionResource"}],"description":"Subscribed resource, where the logs come from","readOnly":true},"serviceName":{"type":"string","description":"Name of the destination log service","readOnly":true},"streamId":{"type":"string","description":"Id of the destination log stream","readOnly":true},"subscriptionId":{"type":"string","description":"Subscription ID","format":"uuid","readOnly":true},"updatedAt":{"type":"string","description":"Last update date of the subscription","format":"date-time","readOnly":true}}},"dbaas.logs.LogSubscriptionCreation":{"type":"object","description":"Log subscription creation payload","properties":{"kind":{"type":"string","description":"Log kind name to subscribe to"},"streamId":{"type":"string","description":"Customer log stream ID","format":"uuid"}},"required":["kind","streamId"]},"dbaas.logs.LogSubscriptionResponse":{"type":"object","description":"Asynchronous operation after subscribing or unsubscribing to a resource logs","properties":{"operationId":{"type":"string","description":"Identifier of the operation","format":"uuid","readOnly":true},"serviceName":{"type":"string","description":"Operation owner's service name","readOnly":true}}},"dbaas.logs.LogUrlCreation":{"type":"object","description":"Log temporary URL creation payload","properties":{"kind":{"type":"string","description":"Log kind name"}},"required":["kind"]},"dbaas.logs.SubscriptionResource":{"type":"object","description":"Log subscription resource","properties":{"name":{"type":"string","description":"Name of subscribed resource","readOnly":true},"type":{"type":"string","description":"Type of subscribed resource","readOnly":true}}},"dbaas.logs.TemporaryLogsLink":{"type":"object","description":"Temporary url information","properties":{"expirationDate":{"type":"string","description":"Temporary url expiration date","format":"date-time","readOnly":true},"url":{"type":"string","description":"Temporary url","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"},"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":{"/me/logs/audit":{"get":{"summary":"Get your audit logs","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/audit.Log"}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Account Logs","Audit Logs"]],"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(\"/me/logs/audit\")\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(\"/me/logs/audit\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/logs/audit/get","required":true}]}},"/me/logs/audit/log/kind":{"get":{"summary":"List available log kinds","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Account Logs","Audit Logs"]],"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(\"/me/logs/audit/log/kind\")\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(\"/me/logs/audit/log/kind\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/logs/audit/log/kind/get","required":true}],"x-expanded-response":"DbaasLogsLogKind"}},"/me/logs/audit/log/kind/{name}":{"get":{"summary":"Get a log kind","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.LogKind"}}}}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Account Logs","Audit Logs"]],"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(\"/me/logs/audit/log/kind/{name}\")\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(\"/me/logs/audit/log/kind/{name}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/logs/audit/log/kind/get","required":true}],"x-response-identifier":"name"}},"/me/logs/audit/log/subscription":{"get":{"summary":"List subscription IDs for a cluster","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"kind","description":"Filter on a specific kind (e.g., audit)","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Account Logs","Audit Logs"]],"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(\"/me/logs/audit/log/subscription\")\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(\"/me/logs/audit/log/subscription\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/logs/audit/log/subscription/get","required":true}],"x-expanded-response":"DbaasLogsLogSubscription"},"post":{"summary":"Create a subscription from logs to a pre-existing LDP stream","security":[{"oAuth2AuthCode":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.LogSubscriptionCreation"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.LogSubscriptionResponse"}}}}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Account Logs","Audit Logs"]],"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: dbaas.logs.LogSubscriptionCreation\nresult = client.post(\"/me/logs/audit/log/subscription\",\n\tkind = None, # Log kind name to subscribe to (type: string)\n\tstreamId = None, # Customer log stream ID (type: string)\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: dbaas.logs.LogSubscriptionCreation\n$result = $ovh->post(\"/me/logs/audit/log/subscription\", array(\n\tkind => null, // Log kind name to subscribe to (type: string)\n\tstreamId => null, // Customer log stream ID (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/logs/audit/log/subscription/create","required":true},{"name":"ldp:apiovh:output/graylog/stream/forwardTo","description":"Required on the targeted LDP service","required":true}]}},"/me/logs/audit/log/subscription/{subscriptionId}":{"delete":{"summary":"Delete a subscription","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"subscriptionId","description":"Subscription ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.LogSubscriptionResponse"}}}}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Account Logs","Audit Logs"]],"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(\"/me/logs/audit/log/subscription/{subscriptionId}\")\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(\"/me/logs/audit/log/subscription/{subscriptionId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/logs/audit/log/subscription/delete","required":true}]},"get":{"summary":"Get subscription details","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"subscriptionId","description":"Subscription ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.LogSubscription"}}}}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Account Logs","Audit Logs"]],"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(\"/me/logs/audit/log/subscription/{subscriptionId}\")\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(\"/me/logs/audit/log/subscription/{subscriptionId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/logs/audit/log/subscription/get","required":true}],"x-response-identifier":"subscriptionId"}},"/me/logs/audit/log/url":{"post":{"summary":"Generate a temporary URL to retrieve logs","security":[{"oAuth2AuthCode":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.LogUrlCreation"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.TemporaryLogsLink"}}}}},"x-developer-hub-navigation":[["Manage & Operate","Identity & Access Management","Account Logs","Audit Logs"]],"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: dbaas.logs.LogUrlCreation\nresult = client.post(\"/me/logs/audit/log/url\",\n\tkind = None, # Log kind name (type: string)\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: dbaas.logs.LogUrlCreation\n$result = $ovh->post(\"/me/logs/audit/log/url\", array(\n\tkind => null, // Log kind name (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:me/logs/audit/log/url/create","required":true}]}}}}
