{"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.OutputGraylogStreamCreation":{"type":"object","description":"New Graylog stream","properties":{"coldStorageCompression":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.StreamColdStorageCompressionEnum"}],"description":"Cold storage compression","nullable":true},"coldStorageContent":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.StreamColdStorageContentEnum"}],"description":"Cold storage archive content","nullable":true},"coldStorageEnabled":{"type":"boolean","description":"Cold storage enabled","nullable":true},"coldStorageNotifyEnabled":{"type":"boolean","description":"Cold storage notify enabled","nullable":true},"coldStorageRetention":{"type":"integer","description":"Cold storage retention time","nullable":true},"description":{"type":"string","description":"Description"},"encryptionKeysIds":{"type":"array","description":"Encryption keys used to encrypt stream archives","nullable":true,"items":{"type":"string","format":"uuid"}},"indexingEnabled":{"type":"boolean","description":"ES indexing enabled","nullable":true},"indexingMaxSize":{"type":"integer","description":"Maximum indexing size (in GB)","nullable":true},"indexingNotifyEnabled":{"type":"boolean","description":"If set, notify when size is near 80, 90 or 100 % of the maximum configured setting","nullable":true},"parentStreamId":{"type":"string","description":"Parent stream ID","nullable":true,"format":"uuid"},"pauseIndexingOnMaxSize":{"type":"boolean","description":"If set, pause indexing when maximum size is reach","nullable":true},"retentionId":{"type":"string","description":"Retention ID","nullable":true,"format":"uuid"},"title":{"type":"string","description":"Title"},"webSocketEnabled":{"type":"boolean","description":"Web Socket enabled","nullable":true}},"required":["description","title"]},"dbaas.logs.OutputGraylogStreamUpdate":{"type":"object","description":"Graylog stream update","properties":{"coldStorageCompression":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.StreamColdStorageCompressionEnum"}],"description":"Cold storage compression","nullable":true},"coldStorageContent":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.StreamColdStorageContentEnum"}],"description":"Cold storage content","nullable":true},"coldStorageEnabled":{"type":"boolean","description":"Cold storage enabled","nullable":true},"coldStorageNotifyEnabled":{"type":"boolean","description":"Cold storage notify enabled","nullable":true},"coldStorageRetention":{"type":"integer","description":"Cold storage retention time","nullable":true},"description":{"type":"string","description":"Description"},"encryptionKeysIds":{"type":"array","description":"Encryption keys used to encrypt stream archives","nullable":true,"items":{"type":"string","format":"uuid"}},"indexingEnabled":{"type":"boolean","description":"ES indexing enabled","nullable":true},"indexingMaxSize":{"type":"integer","description":"Maximum indexing size (in GB)","nullable":true},"indexingNotifyEnabled":{"type":"boolean","description":"If set, notify when size is near 80, 90 or 100 % of the maximum configured setting","nullable":true},"pauseIndexingOnMaxSize":{"type":"boolean","description":"If set, pause indexing when maximum size is reach","nullable":true},"title":{"type":"string","description":"Title"},"webSocketEnabled":{"type":"boolean","description":"Web socket enabled","nullable":true}},"required":["description","title"]},"dbaas.logs.StreamColdStorageCompressionEnum":{"type":"string","description":"Possible values for StreamColdStorageCompressionEnum","enum":["DEFLATED","GZIP","LZMA","ZSTD"]},"dbaas.logs.StreamColdStorageContentEnum":{"type":"string","description":"Possible values for StreamColdStorageContentEnum","enum":["ALL","GELF","PLAIN"]},"dbaas.logs.StreamWithIAM":{"type":"object","description":"Graylog stream","properties":{"canAlert":{"type":"boolean","description":"Indicates if the current user can create alert on the stream","readOnly":true},"clusterId":{"type":"string","description":"Cluster ID","format":"uuid","readOnly":true},"coldStorageCompression":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.StreamColdStorageCompressionEnum"}],"description":"Cold storage compression method","nullable":true,"readOnly":true},"coldStorageContent":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.StreamColdStorageContentEnum"}],"description":"ColdStorage content","nullable":true,"readOnly":true},"coldStorageEnabled":{"type":"boolean","description":"Is Cold storage enabled?","nullable":true,"readOnly":true},"coldStorageNotifyEnabled":{"type":"boolean","description":"Notify on new Cold storage archive","nullable":true,"readOnly":true},"coldStorageRetention":{"type":"integer","description":"Cold storage retention in year","nullable":true,"readOnly":true},"createdAt":{"type":"string","description":"Stream creation","format":"date-time","readOnly":true},"description":{"type":"string","description":"Stream description","readOnly":true},"encryptionKeysIds":{"type":"array","description":"Encryption keys used to encrypt stream archives","nullable":true,"items":{"type":"string","format":"uuid"},"readOnly":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"indexingCurrentSize":{"type":"integer","description":"Indexing current size (in bytes)","nullable":true,"readOnly":true},"indexingEnabled":{"type":"boolean","description":"Enable ES indexing","nullable":true,"readOnly":true},"indexingMaxSize":{"type":"integer","description":"Maximum indexing size (in GB)","nullable":true,"readOnly":true},"indexingNotifyEnabled":{"type":"boolean","description":"If set, notify when size is near 80, 90 or 100 % of the maximum configured setting","nullable":true,"readOnly":true},"isEditable":{"type":"boolean","description":"Indicates if you are allowed to edit entry","readOnly":true},"nbAlertCondition":{"type":"integer","description":"Number of alert condition","readOnly":true},"nbArchive":{"type":"integer","description":"Number of coldstored archives","readOnly":true},"nbSubscription":{"type":"integer","description":"Number of subscriptions targeting this stream","readOnly":true},"parentStreamId":{"type":"string","description":"Parent stream ID","nullable":true,"format":"uuid","readOnly":true},"pauseIndexingOnMaxSize":{"type":"boolean","description":"If set, pause indexing when maximum size is reach","nullable":true,"readOnly":true},"retentionId":{"type":"string","description":"Retention ID","format":"uuid","readOnly":true},"streamId":{"type":"string","description":"Stream ID","format":"uuid","readOnly":true},"title":{"type":"string","description":"Stream name","readOnly":true},"updatedAt":{"type":"string","description":"Stream last update","nullable":true,"format":"date-time","readOnly":true},"webSocketEnabled":{"type":"boolean","description":"Enable Websocket","nullable":true,"readOnly":true}}},"dbaas.logs.Url":{"type":"object","description":"Web address","properties":{"address":{"type":"string","description":"Web URI","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/dbaas.logs.UrlTypeEnum"}],"description":"Service type","readOnly":true}}},"dbaas.logs.UrlTypeEnum":{"type":"string","description":"Possible values for UrlTypeEnum","enum":["CONSOLE","ELASTICSEARCH_API","GRAYLOG_API","GRAYLOG_WEBUI","HTTP_GELF","HTTP_TLS_GELF","KIBANA_WEBUI","OPENSEARCH_API","OSD_WEBUI","PROMETHEUS_API","SERVICE_DOMAIN","TCP_BEATS","TCP_CAP_N_PROTO","TCP_GELF","TCP_LTSV_LINE","TCP_LTSV_NUL","TCP_RFC5424","TCP_TLS_BEATS","TCP_TLS_CAP_N_PROTO","TCP_TLS_GELF","TCP_TLS_LTSV_LINE","TCP_TLS_LTSV_NUL","TCP_TLS_RFC5424","UDP_CAP_N_PROTO","UDP_GELF","UDP_LTSV_LINE","UDP_LTSV_NUL","UDP_RFC5424","WEB_SOCKET"]},"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":{"/dbaas/logs/{serviceName}/output/graylog/stream":{"get":{"summary":"List data streams","description":"Returns the data streams of the Logs Data Platform service.","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"}}}},{"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"}}}}},"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","Data streams@@@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\")\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\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:output/graylog/stream/get","required":true}],"x-expanded-response":"DbaasLogsStreamWithIAM"},"post":{"summary":"Create a data stream","description":"Creates a data stream on the Logs Data Platform service.","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.OutputGraylogStreamCreation"}}}},"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::ColdStorageDenyForCluster":{"value":{"class":"Client::Forbidden::ColdStorageDenyForCluster","message":"Stream coldstorage is denied on {{.cluster_type}} clusters"}},"Client::Forbidden::ColdStorageDenyWithoutKey":{"value":{"class":"Client::Forbidden::ColdStorageDenyWithoutKey","message":"Stream coldstorage is denied on {{.cluster_type}} clusters without encryption key"}},"Client::Forbidden::ItemQuotaReached":{"value":{"class":"Client::Forbidden::ItemQuotaReached","message":"{{.targetType}} quota reached for service '{{.serviceName}}' owned by '{{.username}}'! ({{.current}}, allowed: {{.allowed}})"}},"Client::Forbidden::ParentStreamLocked":{"value":{"class":"Client::Forbidden::ParentStreamLocked","message":"A locked stream cannot be used as a parent"}},"Client::Forbidden::ServiceUnavailable":{"value":{"class":"Client::Forbidden::ServiceUnavailable","message":"Service '{{.serviceName}}' unavailable, status is '{{.status}}'"}},"Client::Forbidden::SettingOnlyForCluster":{"value":{"class":"Client::Forbidden::SettingOnlyForCluster","message":"'{{.setting}}' can only be set on {{.cluster_type}} clusters"}},"Client::Forbidden::SubStreamColdstorageAddRules":{"value":{"class":"Client::Forbidden::SubStreamColdstorageAddRules","message":"Substreams cannot be indexed immediately, please register some rules and then enable indexation by updating entry"}},"Client::Forbidden::SubStreamColdstorageIndexingMaxSize":{"value":{"class":"Client::Forbidden::SubStreamColdstorageIndexingMaxSize","message":"Substreams cannot be indexed immediately, indexingMaxSize MUST be Null"}}}}}},"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::ClusterRetentionNotFound":{"value":{"class":"Client::NotFound::ClusterRetentionNotFound","message":"Cluster retention '{{.retentionId}}' not found for cluster '{{.clusterId}}'"}},"Client::NotFound::EncryptionKeyDoesNotExists":{"value":{"class":"Client::NotFound::EncryptionKeyDoesNotExists","message":"Encryption key '{{.criteria}}' does not exist or is not owned by you"}},"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::TitleAlreadyUsed":{"value":{"class":"Client::Conflict::TitleAlreadyUsed","message":"Title '{{.title}}' is already used"}}}}}},"501":{"description":"Error 501 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::NotImplemented::SubStreamColdstorage":{"value":{"class":"Server::NotImplemented::SubStreamColdstorage","message":"Coldstorage is not available yet on sub-streams"}},"Server::NotImplemented::SubStreamColdstorageOnAccount":{"value":{"class":"Server::NotImplemented::SubStreamColdstorageOnAccount","message":"Cannot create substream on '{{.current}}' account, allowed on '{{.required}}'"}}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Logs Data Platform","Data streams@@@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\n# Request body type: dbaas.logs.OutputGraylogStreamCreation\nresult = client.post(\"/dbaas/logs/{serviceName}/output/graylog/stream\",\n\tcoldStorageCompression = None, # Cold storage compression (type: dbaas.logs.StreamColdStorageCompressionEnum, nullable)\n\tcoldStorageContent = None, # Cold storage archive content (type: dbaas.logs.StreamColdStorageContentEnum, nullable)\n\tcoldStorageEnabled = None, # Cold storage enabled (type: boolean, nullable)\n\tcoldStorageNotifyEnabled = None, # Cold storage notify enabled (type: boolean, nullable)\n\tcoldStorageRetention = None, # Cold storage retention time (type: integer, nullable)\n\tdescription = None, # Description (type: string)\n\tencryptionKeysIds = None, # Encryption keys used to encrypt stream archives (type: array, nullable)\n\tindexingEnabled = None, # ES indexing enabled (type: boolean, nullable)\n\tindexingMaxSize = None, # Maximum indexing size (in GB) (type: integer, nullable)\n\tindexingNotifyEnabled = None, # If set, notify when size is near 80, 90 or 100 % of the maximum configured setting (type: boolean, nullable)\n\tparentStreamId = None, # Parent stream ID (type: string, nullable)\n\tpauseIndexingOnMaxSize = None, # If set, pause indexing when maximum size is reach (type: boolean, nullable)\n\tretentionId = None, # Retention ID (type: string, nullable)\n\ttitle = None, # Title (type: string)\n\twebSocketEnabled = None, # Web Socket enabled (type: boolean, nullable)\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.OutputGraylogStreamCreation\n$result = $ovh->post(\"/dbaas/logs/{serviceName}/output/graylog/stream\", array(\n\tcoldStorageCompression => null, // Cold storage compression (type: dbaas.logs.StreamColdStorageCompressionEnum, nullable)\n\tcoldStorageContent => null, // Cold storage archive content (type: dbaas.logs.StreamColdStorageContentEnum, nullable)\n\tcoldStorageEnabled => null, // Cold storage enabled (type: boolean, nullable)\n\tcoldStorageNotifyEnabled => null, // Cold storage notify enabled (type: boolean, nullable)\n\tcoldStorageRetention => null, // Cold storage retention time (type: integer, nullable)\n\tdescription => null, // Description (type: string)\n\tencryptionKeysIds => null, // Encryption keys used to encrypt stream archives (type: array, nullable)\n\tindexingEnabled => null, // ES indexing enabled (type: boolean, nullable)\n\tindexingMaxSize => null, // Maximum indexing size (in GB) (type: integer, nullable)\n\tindexingNotifyEnabled => null, // If set, notify when size is near 80, 90 or 100 % of the maximum configured setting (type: boolean, nullable)\n\tparentStreamId => null, // Parent stream ID (type: string, nullable)\n\tpauseIndexingOnMaxSize => null, // If set, pause indexing when maximum size is reach (type: boolean, nullable)\n\tretentionId => null, // Retention ID (type: string, nullable)\n\ttitle => null, // Title (type: string)\n\twebSocketEnabled => null, // Web Socket enabled (type: boolean, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:output/graylog/stream/create","required":true}]}},"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}":{"delete":{"summary":"Delete a data stream","description":"Deletes the data stream.","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":{"$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::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::StreamIsParent":{"value":{"class":"Client::Forbidden::StreamIsParent","message":"Stream '{{.title}}' has {{.nbChildren}} child(ren): {{.children}}"}}}}}},"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@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}\")\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}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:output/graylog/stream/delete","required":true}]},"get":{"summary":"Get a data stream","description":"Returns the data stream.","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":{"$ref":"#/components/schemas/dbaas.logs.StreamWithIAM"}}}},"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@@@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}\")\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}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:output/graylog/stream/get","required":true}]},"put":{"summary":"Update a data stream","description":"Updates the data stream.","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.OutputGraylogStreamUpdate"}}}},"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::ColdStorageDenyForCluster":{"value":{"class":"Client::Forbidden::ColdStorageDenyForCluster","message":"Stream coldstorage is denied on {{.cluster_type}} clusters"}},"Client::Forbidden::ItemQuotaReached":{"value":{"class":"Client::Forbidden::ItemQuotaReached","message":"{{.targetType}} quota reached for service '{{.serviceName}}' owned by '{{.username}}'! ({{.current}}, allowed: {{.allowed}})"}},"Client::Forbidden::NoRuleSet":{"value":{"class":"Client::Forbidden::NoRuleSet","message":"Cannot enable indexing if no rule set!"}},"Client::Forbidden::OnlyOwnerCanPerformAction":{"value":{"class":"Client::Forbidden::OnlyOwnerCanPerformAction","message":"Only the owner is allowed to perform this action"}}}}}},"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::ClusterRetentionNotFound":{"value":{"class":"Client::NotFound::ClusterRetentionNotFound","message":"Cluster retention '{{.retentionId}}' not found for cluster '{{.clusterId}}'"}},"Client::NotFound::EncryptionKeyDoesNotExists":{"value":{"class":"Client::NotFound::EncryptionKeyDoesNotExists","message":"Encryption key '{{.criteria}}' does not exist or is not owned by you"}},"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::TitleAlreadyUsed":{"value":{"class":"Client::Conflict::TitleAlreadyUsed","message":"Title '{{.title}}' is already used"}}}}}}},"x-developer-hub-navigation":[["Manage & Operate","Logs Data Platform","Data streams@@@60"]],"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.OutputGraylogStreamUpdate\nresult = client.put(\"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}\",\n\tcoldStorageCompression = None, # Cold storage compression (type: dbaas.logs.StreamColdStorageCompressionEnum, nullable)\n\tcoldStorageContent = None, # Cold storage content (type: dbaas.logs.StreamColdStorageContentEnum, nullable)\n\tcoldStorageEnabled = None, # Cold storage enabled (type: boolean, nullable)\n\tcoldStorageNotifyEnabled = None, # Cold storage notify enabled (type: boolean, nullable)\n\tcoldStorageRetention = None, # Cold storage retention time (type: integer, nullable)\n\tdescription = None, # Description (type: string)\n\tencryptionKeysIds = None, # Encryption keys used to encrypt stream archives (type: array, nullable)\n\tindexingEnabled = None, # ES indexing enabled (type: boolean, nullable)\n\tindexingMaxSize = None, # Maximum indexing size (in GB) (type: integer, nullable)\n\tindexingNotifyEnabled = None, # If set, notify when size is near 80, 90 or 100 % of the maximum configured setting (type: boolean, nullable)\n\tpauseIndexingOnMaxSize = None, # If set, pause indexing when maximum size is reach (type: boolean, nullable)\n\ttitle = None, # Title (type: string)\n\twebSocketEnabled = None, # Web socket enabled (type: boolean, nullable)\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.OutputGraylogStreamUpdate\n$result = $ovh->put(\"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}\", array(\n\tcoldStorageCompression => null, // Cold storage compression (type: dbaas.logs.StreamColdStorageCompressionEnum, nullable)\n\tcoldStorageContent => null, // Cold storage content (type: dbaas.logs.StreamColdStorageContentEnum, nullable)\n\tcoldStorageEnabled => null, // Cold storage enabled (type: boolean, nullable)\n\tcoldStorageNotifyEnabled => null, // Cold storage notify enabled (type: boolean, nullable)\n\tcoldStorageRetention => null, // Cold storage retention time (type: integer, nullable)\n\tdescription => null, // Description (type: string)\n\tencryptionKeysIds => null, // Encryption keys used to encrypt stream archives (type: array, nullable)\n\tindexingEnabled => null, // ES indexing enabled (type: boolean, nullable)\n\tindexingMaxSize => null, // Maximum indexing size (in GB) (type: integer, nullable)\n\tindexingNotifyEnabled => null, // If set, notify when size is near 80, 90 or 100 % of the maximum configured setting (type: boolean, nullable)\n\tpauseIndexingOnMaxSize => null, // If set, pause indexing when maximum size is reach (type: boolean, nullable)\n\ttitle => null, // Title (type: string)\n\twebSocketEnabled => null, // Web socket enabled (type: boolean, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:output/graylog/stream/edit","required":true}]}},"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/url":{"get":{"summary":"List data stream URLs","description":"Returns the data stream URLs 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":{"$ref":"#/components/schemas/dbaas.logs.Url"}}}}},"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@@@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\nresult = client.get(\"/dbaas/logs/{serviceName}/output/graylog/stream/{streamId}/url\")\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}/url\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"ldp:apiovh:output/graylog/stream/url/get","required":true}]}}}}