{"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.OutputGraylogStreamRuleCreation":{"type":"object","description":"New rule on Graylog stream","properties":{"field":{"type":"string","description":"Field name"},"isInverted":{"type":"boolean","description":"Invert condition","nullable":true},"operator":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.StreamRuleOperatorEnum"}],"description":"Field operator"},"value":{"type":"string","description":"Field value"}},"required":["field","operator","value"]},"dbaas.logs.StreamRule":{"type":"object","description":"Stream rule","properties":{"field":{"type":"string","description":"Field name","readOnly":true},"isInverted":{"type":"boolean","description":"Invert condition","nullable":true,"readOnly":true},"operator":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.StreamRuleOperatorEnum"}],"description":"Field operator","nullable":true,"readOnly":true},"ruleId":{"type":"string","description":"Stream rule ID","format":"uuid","readOnly":true},"value":{"type":"string","description":"Field value","readOnly":true}}},"dbaas.logs.StreamRuleOperatorEnum":{"type":"string","description":"Possible values for StreamRuleOperatorEnum","enum":["FIELD_PRESENCE","GREATER_THAN","MATCH_EXACTLY","SMALLER_THAN"]},"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}/output/graylog/stream/{streamId}/rule":{"get":{"summary":"List stream rules","description":"Returns the stream rules of the Logs Data Platform service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"path","name":"streamId","description":"Stream ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}}},"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::StreamDoesNotExists":{"value":{"class":"Client::NotFound::StreamDoesNotExists","message":"Stream '{{.criteria}}' doesn't exist"}}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Logs Data Platform","Data streams","Rules@@@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(\"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule\")\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}/output/graylog/stream/{streamId}/rule\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:output/graylog/stream/rule/get","required":true}],"x-expanded-response":"DbaasLogsStreamRule"},"post":{"summary":"Create a stream rule","description":"Creates a stream rule on the Logs Data Platform service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"path","name":"streamId","description":"Stream ID","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.OutputGraylogStreamRuleCreation"}}}},"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::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}}'"}},"Client::Forbidden::StreamLocked":{"value":{"class":"Client::Forbidden::StreamLocked","message":"You are not allowed to act on this stream as long as it is locked"}}}}}},"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::StreamDoesNotExists":{"value":{"class":"Client::NotFound::StreamDoesNotExists","message":"Stream '{{.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::RuleAlreadyExists":{"value":{"class":"Client::Conflict::RuleAlreadyExists","message":"A rule with the same parameters already exists ({{.ruleId}})"}}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Logs Data Platform","Data streams","Rules@@@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: dbaas.logs.OutputGraylogStreamRuleCreation\nresult = client.post(\"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule\",\n\tfield = None, # Field name (type: string)\n\tisInverted = None, # Invert condition (type: boolean, nullable)\n\toperator = None, # Field operator (type: dbaas.logs.StreamRuleOperatorEnum)\n\tvalue = None, # Field value (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.OutputGraylogStreamRuleCreation\n$result = $ovh->post(\"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule\", array(\n\tfield => null, // Field name (type: string)\n\tisInverted => null, // Invert condition (type: boolean, nullable)\n\toperator => null, // Field operator (type: dbaas.logs.StreamRuleOperatorEnum)\n\tvalue => null, // Field value (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:output/graylog/stream/rule/create","required":true}]}},"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule/{ruleId}":{"delete":{"summary":"Delete a stream rule","description":"Deletes the stream rule.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"ruleId","description":"Rule ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"path","name":"streamId","description":"Stream 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::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::StreamDoesNotExists":{"value":{"class":"Client::NotFound::StreamDoesNotExists","message":"Stream '{{.criteria}}' doesn't exist"}},"Client::NotFound::StreamRuleDoesNotExists":{"value":{"class":"Client::NotFound::StreamRuleDoesNotExists","message":"Stream '{{.streamId}}' rule '{{.ruleId}}' doesn't exist"}}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Logs Data Platform","Data streams","Rules@@@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(\"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule/{ruleId}\")\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}/output/graylog/stream/{streamId}/rule/{ruleId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:output/graylog/stream/rule/delete","required":true}]},"get":{"summary":"Get a stream rule","description":"Returns the stream rule.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"ruleId","description":"Rule ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}},{"in":"path","name":"streamId","description":"Stream ID","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/dbaas.logs.StreamRule"}}}},"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::StreamDoesNotExists":{"value":{"class":"Client::NotFound::StreamDoesNotExists","message":"Stream '{{.criteria}}' doesn't exist"}},"Client::NotFound::StreamRuleDoesNotExists":{"value":{"class":"Client::NotFound::StreamRuleDoesNotExists","message":"Stream '{{.streamId}}' rule '{{.ruleId}}' doesn't exist"}}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Logs Data Platform","Data streams","Rules@@@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(\"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/rule/{ruleId}\")\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}/output/graylog/stream/{streamId}/rule/{ruleId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:output/graylog/stream/rule/get","required":true}],"x-response-identifier":"ruleId"}}}}