{"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 !"},"dbaas.logs.Operation":{"type":"object","description":"Asynchronous operation","properties":{"aliasId":{"type":"string","description":"Alias used","nullable":true,"format":"uuid","readOnly":true},"createdAt":{"type":"string","description":"Operation creation","format":"date-time","readOnly":true},"dashboardId":{"type":"string","description":"Dashboard used","nullable":true,"format":"uuid","readOnly":true},"encryptionKeyId":{"type":"string","description":"Encryption key used","nullable":true,"format":"uuid","readOnly":true},"indexId":{"type":"string","description":"Index used","nullable":true,"format":"uuid","readOnly":true},"inputId":{"type":"string","description":"Input used","nullable":true,"format":"uuid","readOnly":true},"operationId":{"type":"string","description":"Operation ID","format":"uuid","readOnly":true},"osdId":{"type":"string","description":"OpenSearch Dashboards used","nullable":true,"format":"uuid","readOnly":true},"roleId":{"type":"string","description":"Role used","nullable":true,"format":"uuid","readOnly":true},"serviceName":{"type":"string","description":"Service name","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.OperationStateEnum"}],"description":"Operation status","readOnly":true},"streamId":{"type":"string","description":"Stream used","nullable":true,"format":"uuid","readOnly":true},"subscriptionId":{"type":"string","description":"Subscription used","nullable":true,"format":"uuid","readOnly":true},"tenantId":{"type":"string","description":"Metrics tenant used","nullable":true,"format":"uuid","readOnly":true},"tokenId":{"type":"string","description":"Token used","nullable":true,"format":"uuid","readOnly":true},"updatedAt":{"type":"string","description":"Operation last update","nullable":true,"format":"date-time","readOnly":true}}},"dbaas.logs.OperationStateEnum":{"type":"string","description":"Possible values for OperationStateEnum","enum":["FAILURE","PENDING","RECEIVED","RETRY","REVOKED","RUNNING","STARTED","SUCCESS"]},"dbaas.logs.Token":{"type":"object","description":"Token","properties":{"clusterId":{"type":"string","description":"Cluster ID","nullable":true,"format":"uuid","readOnly":true},"createdAt":{"type":"string","description":"Token creation","format":"date-time","readOnly":true},"name":{"type":"string","description":"Token name","readOnly":true},"tokenId":{"type":"string","description":"Token ID","format":"uuid","readOnly":true},"updatedAt":{"type":"string","description":"Token last update","nullable":true,"format":"date-time","readOnly":true},"value":{"type":"string","description":"Token value","readOnly":true}}},"dbaas.logs.TokenCreation":{"type":"object","description":"New token","properties":{"clusterId":{"type":"string","description":"Cluster ID","nullable":true,"format":"uuid"},"name":{"type":"string","description":"Token name"}},"required":["name"]},"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":{"/dbaas/logs/{serviceName}/token":{"get":{"summary":"List tokens","description":"Returns the tokens of the Logs Data Platform service.","deprecated":true,"x-deprecation-date":"2025-09-17T00:00:00Z","x-deletion-date":"2026-09-17T00:00:00Z","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"namePattern","description":"Filter by name (like)","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"403":{"description":"Error 403 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::Forbidden::IAMService":{"value":{"class":"Client::Forbidden::IAMService","message":"IAM is enabled on this service so this action is no more permitted"}}}}}},"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::ServiceDoesNotExists":{"value":{"class":"Client::NotFound::ServiceDoesNotExists","message":"Service '{{.criteria}}' doesn't exist"}}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Logs Data Platform","Tokens@@@10"]],"x-badges":[{"color":"red","label":"Deprecated, will be removed"}],"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(\"/dbaas/logs/{serviceName}/token\")\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(\"/dbaas/logs/{serviceName}/token\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:token/get","required":true}],"x-expanded-response":"DbaasLogsToken"},"post":{"summary":"Create a token","description":"Creates a token on the Logs Data Platform service.","deprecated":true,"x-deprecation-date":"2025-09-17T00:00:00Z","x-deletion-date":"2026-09-17T00:00:00Z","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.TokenCreation"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.Operation"}}}},"403":{"description":"Error 403 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::Forbidden::AccessDenied":{"value":{"class":"Client::Forbidden::AccessDenied","message":"Cluster '{{.clusterId}}' access denied to {{.serviceName}}, message sent to admin"}},"Client::Forbidden::Busy":{"value":{"class":"Client::Forbidden::Busy","message":"An operation is already running for this service: {{.operations}}. Please retry later."}},"Client::Forbidden::IAMService":{"value":{"class":"Client::Forbidden::IAMService","message":"IAM is enabled on this service so this action is no more permitted"}},"Client::Forbidden::ServiceUnavailable":{"value":{"class":"Client::Forbidden::ServiceUnavailable","message":"Service '{{.serviceName}}' unavailable, status is '{{.status}}'"}}}}}},"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::ClusterDoesNotExists":{"value":{"class":"Client::NotFound::ClusterDoesNotExists","message":"Cluster '{{.criteria}}' doesn't exist"}},"Client::NotFound::ServiceDoesNotExists":{"value":{"class":"Client::NotFound::ServiceDoesNotExists","message":"Service '{{.criteria}}' doesn't exist"}}}}}},"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::TokenNameAlreadyUsed":{"value":{"class":"Client::Conflict::TokenNameAlreadyUsed","message":"Token name '{{.name}}' already used by '{{.serviceName}}'"}}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Logs Data Platform","Tokens@@@30"]],"x-badges":[{"color":"red","label":"Deprecated, will be removed"}],"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.TokenCreation\nresult = client.post(\"/dbaas/logs/{serviceName}/token\",\n\tclusterId = None, # Cluster ID (type: string, nullable)\n\tname = None, # Token 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.TokenCreation\n$result = $ovh->post(\"/dbaas/logs/{serviceName}/token\", array(\n\tclusterId => null, // Cluster ID (type: string, nullable)\n\tname => null, // Token name (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:token/create","required":true}]}},"/dbaas/logs/{serviceName}/token/{tokenId}":{"delete":{"summary":"Delete a token","description":"Deletes the token.","deprecated":true,"x-deprecation-date":"2025-09-17T00:00:00Z","x-deletion-date":"2026-09-17T00:00:00Z","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"path","name":"tokenId","description":"Token ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.Operation"}}}},"403":{"description":"Error 403 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::Forbidden::Busy":{"value":{"class":"Client::Forbidden::Busy","message":"An operation is already running for this service: {{.operations}}. Please retry later."}},"Client::Forbidden::IAMService":{"value":{"class":"Client::Forbidden::IAMService","message":"IAM is enabled on this service so this action is no more permitted"}},"Client::Forbidden::OnlyOwnerCanPerformAction":{"value":{"class":"Client::Forbidden::OnlyOwnerCanPerformAction","message":"Only the owner is allowed to perform this action"}},"Client::Forbidden::ServiceUnavailable":{"value":{"class":"Client::Forbidden::ServiceUnavailable","message":"Service '{{.serviceName}}' unavailable, status is '{{.status}}'"}}}}}},"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::ServiceDoesNotExists":{"value":{"class":"Client::NotFound::ServiceDoesNotExists","message":"Service '{{.criteria}}' doesn't exist"}},"Client::NotFound::TokenDoesNotExists":{"value":{"class":"Client::NotFound::TokenDoesNotExists","message":"Token '{{.criteria}}' doesn't exist"}}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Logs Data Platform","Tokens@@@40"]],"x-badges":[{"color":"red","label":"Deprecated, will be removed"}],"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(\"/dbaas/logs/{serviceName}/token/{tokenId}\")\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(\"/dbaas/logs/{serviceName}/token/{tokenId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:token/delete","required":true}]},"get":{"summary":"Get a token","description":"Returns the token.","deprecated":true,"x-deprecation-date":"2025-09-17T00:00:00Z","x-deletion-date":"2026-09-17T00:00:00Z","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"path","name":"tokenId","description":"Token ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.Token"}}}},"403":{"description":"Error 403 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::Forbidden::IAMService":{"value":{"class":"Client::Forbidden::IAMService","message":"IAM is enabled on this service so this action is no more permitted"}}}}}},"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::ServiceDoesNotExists":{"value":{"class":"Client::NotFound::ServiceDoesNotExists","message":"Service '{{.criteria}}' doesn't exist"}},"Client::NotFound::TokenDoesNotExists":{"value":{"class":"Client::NotFound::TokenDoesNotExists","message":"Token '{{.criteria}}' doesn't exist"}}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Logs Data Platform","Tokens@@@20"]],"x-badges":[{"color":"red","label":"Deprecated, will be removed"}],"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(\"/dbaas/logs/{serviceName}/token/{tokenId}\")\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(\"/dbaas/logs/{serviceName}/token/{tokenId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:token/get","required":true}],"x-response-identifier":"tokenId"}}}}